Skip to content

Commit e9063ba

Browse files
committed
Include configuration to build the package and instructions to release.
1 parent 03da1ea commit e9063ba

4 files changed

Lines changed: 37 additions & 3 deletions

File tree

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# examples/*.yarnc
22
# examples/*.csv
33
**/__pycache__
4-
.python-version
4+
.python-version
5+
*.egg-info/
6+
dist/

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,15 @@ Only a subset of Yarn Spinner opcodes are currently implemented. This will certa
7676

7777
This project uses Python 3 and has a basic test suite.
7878

79-
1. `pip install -r requirements.txt`
80-
2. `py.test`
79+
1. Install dependencies by running `pip install -r requirements.txt`
80+
2. Run `py.test`
81+
82+
To make a release:
83+
84+
1. Make sure you have the latest version of `build` installed:
85+
> `pip install --upgrade build`
86+
2. Increment the `version` key in `setup.cfg`.
87+
3. Run `python -m build`.
8188

8289
## Updating the examples
8390

pyproject.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[build-system]
2+
requires = [
3+
"setuptools>=42",
4+
"wheel"
5+
]
6+
build-backend = "setuptools.build_meta"

setup.cfg

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# https://packaging.python.org/tutorials/packaging-projects/
2+
3+
[metadata]
4+
name = yarnrunner-python
5+
version = 0.0.1
6+
author = Sam Weaver
7+
author_email = sweaver@relaypro.com
8+
description = An unofficial Python interpreter for compiled Yarn Spinner programs.
9+
long_description = file: README.md
10+
long_description_content_type = text/markdown
11+
url = https://github.com/relaypro-open/YarnRunner-Python
12+
classifiers =
13+
Programming Language :: Python :: 3
14+
Operating System :: OS Independent
15+
Development Status :: 3 - Alpha
16+
17+
[options]
18+
packages = yarnrunner_python
19+
python_requires = >=3.6

0 commit comments

Comments
 (0)