https://github.com/karantan/flityard
Testing project for flit
https://github.com/karantan/flityard
Last synced: about 2 months ago
JSON representation
Testing project for flit
- Host: GitHub
- URL: https://github.com/karantan/flityard
- Owner: karantan
- License: mit
- Created: 2018-04-25T15:28:23.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-25T17:00:17.000Z (about 7 years ago)
- Last Synced: 2024-10-07T09:19:03.434Z (8 months ago)
- Language: Python
- Size: 5.86 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# flityard
Test project for better understanding of the
[PEP 518](https://www.python.org/dev/peps/pep-0518/) (a.k.a. pyproject.toml)
and release process with [flit](https://github.com/takluyver/flit/)
## Installation
You need to have [`flit` installed](https://github.com/takluyver/flit#install).
You also need to have `.pypirc` file
[configured](https://docs.python.org/3.6/distutils/packageindex.html#pypirc).
To install your package during development use:
```bash
$ flit install --symlink --python path/to/virtualenv/bin/python
```
## 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 `.dev0` to it. We follow
[semantic versioning](https://semver.org/).
When it comes time to release we can just drop the `.dev0` from `__version__` and
the `CHANGELOG.md`, commit, and run flit publish.
When you drop the `.dev0` from `__version__` creata a commit with the following
message: `Preparing release `
Then publish the release:
```bash
$ flit publish
```
Then "go back to development":
- add the `.dev0` to `__version__`
- create a commit with the following message: `Back to development: `
To `CHANGELOG.md` add new unreleased section:
```
(unreleased)
------------------
- Nothing changed yet.
```
## Usage
```bash
$ 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
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request