A very simple library.
Project description
flityard
Test project for better understanding of the PEP 518 (a.k.a. pyproject.toml) and release process with flit
Installation
You need to have flit
installed.
You also need to have .pypirc
file
configured.
How to do a release
In __init__.py
we have version number in a __version__
attribute at the top.
Once we do a release we immediately bump the version number by a patch/bugfix
level and append .dev to it. We follow
semantic versioning.
When it comes time to release we can just drop the .dev from __version__
and
the CHANGELOG.md
, commit, and run flit publish.
When you drop the .dev from __version__
creata a commit with the following
message: Preparing release <version>
Then publish the release:
$ flit publish
Then "go back to development":
- add the
.dev
to__version__
- create a commit with the following message:
Back to development: <new_version>
To CHANGELOG.md
add new unreleased section:
<new_version> (unreleased)
------------------
- Nothing changed yet.
Usage
$ pip install flintyard
$ python
>>> from flintyard import main
>>> main.hello_world()
Hello world
Further read
- https://flit.readthedocs.io/en/latest/
- https://snarky.ca/clarifying-pep-518/
- https://snarky.ca/how-i-manage-package-version-numbers/
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flityard-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa3f5683bf9415fd032728b7dbfa29fb81ce10d4b4c54f9f94d39b6f80d6ed09 |
|
MD5 | 7e557db556a8f65fa2f5eb1eb59d0472 |
|
BLAKE2b-256 | a38af1ed85919bd7f6bd9a2487fe0024fa90503763c6bacd7fbb140b64575839 |