39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# Changes
|
|
|
|
Please submit a pull-request if you make some changes that you feel would be helpful to others.
|
|
|
|
But please keep in mind:
|
|
|
|
- breaking changes are a problem, for usual reasons
|
|
- not everyone has the same needs as you
|
|
- there can be security implications for any change
|
|
|
|
## Reference for Maintainers and Contributors
|
|
|
|
- [Details on setup.py](https://packaging.python.org/tutorials/packaging-projects/)
|
|
|
|
## Distributing Changes
|
|
|
|
To build to release for Pypi:
|
|
|
|
- `python3 setup.py sdist bdist_wheel`
|
|
- creates files in `./dist`
|
|
- then `twine upload --repository-url https://test.pypi.org/legacy/ dist/*` to test
|
|
- visit: <https://test.pypi.org/project/ckcc-protocol/> to preview
|
|
- make a fresh virtual env, activate it.
|
|
- get latest test version:
|
|
`python3 -m pip install --index-url https://test.pypi.org/simple/ ckcc-protocol --no-cache-dir`
|
|
- but since most dependances aren't on testpypi repo, install those after each error
|
|
- you may need to force the version number to get the updated file
|
|
- test `ckcc list` works
|
|
- test `python -m ckcc` works
|
|
- final upload: `twine upload dist/*`
|
|
|
|
## How to Release New Version
|
|
|
|
- update `ckcc/__init__.py` with new `__version__` string
|
|
- `python3 setup.py sdist bdist_wheel`
|
|
- maybe delete old version from `./dist`
|
|
- tag source code with new version (at this point)
|
|
- `twine upload dist/*1.x.y*` when ready, use `__token__` as username, and API token as password
|