-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,42 @@ | ||
# Currencies, Monetary Value Objects, Arithmetic and Conversion | ||
|
||
![](https://github.com/vst/pypara/workflows/Install%20and%20Test/badge.svg) | ||
![](https://img.shields.io/pypi/v/pypara?style=flat-square) | ||
![](https://img.shields.io/pypi/pyversions/pypara?style=flat-square) | ||
![](https://img.shields.io/github/license/vst/pypara?style=flat-square) | ||
![](https://img.shields.io/github/actions/workflow/status/vst/pypara/test.yml?style=flat-square) | ||
![](https://img.shields.io/github/issues/vst/pypara?style=flat-square) | ||
![](https://img.shields.io/github/last-commit/vst/pypara?style=flat-square) | ||
|
||
> **TODO**: Provide a complete README. | ||
## Development Notes | ||
|
||
Create a virtual environment: | ||
Enter the Nix shell: | ||
|
||
```sh | ||
nix-shell | ||
``` | ||
python3.8 -m venv /opt/venvs/pypara3.8 | ||
``` | ||
|
||
Activate the virtual environment: | ||
|
||
``` | ||
source /opt/venvs/pypara3.8/bin/activate | ||
``` | ||
|
||
Upgrade base dependencies: | ||
|
||
``` | ||
pip install --upgrade pip setuptools | ||
``` | ||
Run the test suite: | ||
|
||
Install production and development dependencies: | ||
|
||
``` | ||
pip install -e . -r dev-requirements.txt | ||
```sh | ||
tox | ||
``` | ||
|
||
Make sure that [tox](https://tox.readthedocs.io/en/latest/) completes successfully: | ||
Alternatively: | ||
|
||
``` | ||
tox | ||
```sh | ||
nix-shell --argstr python python310 --run tox | ||
nix-shell --argstr python python311 --run tox | ||
``` | ||
|
||
## Publishing | ||
|
||
To build a package and upload to PyPI: | ||
|
||
``` | ||
pip install --upgrade twine | ||
python setup.py sdist bdist_wheel | ||
```sh | ||
rm -Rf dist/ | ||
python -m build | ||
twine check dist/* | ||
twine upload -s dist/* | ||
``` | ||
``` |