README_dev.md

DEVELOPMENT BINNACLE

Tools used

• Python: 3.7
• Pipenv: 2018.11.26
• Twine : 3.1.1
• bumb2version : 1.0.0

Dependencies

• requests : 2.23.0

Development dependencies

• python-dotenv : 0.12.0

Set up local development

Run development local:

    cd sync-py
    pipenv install --dev -e .
    pipenv graph

 Versioning

1. Install bump2version: pip install --upgrade bump2version

2. Then run the respective version update:

• Major: pipenv run bump2version major // 0.1.0 --> 1.0.0
• Minor: pipenv run bump2version minor // 0.1.0 --> 0.2.0
• Patch: pipenv run bump2version patch // 0.1.0 --> 0.1.1

Publish on test.pypi.org

1.Create dist files:

pipenv run python setup.py sdist bdist_wheel

2.Check dist files:

twine check dist/*

3.Publish on test.pypi.org:

twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Don't forget to increase the version

Test from test.pypi.org

1. Pipfile

[[source]]
name = "test"
url = "https://test.pypi.org/simple"
verify_ssl = true

[dev-packages]
python-dotenv = "*"

[packages]
sync-py = {index = "test",version = "*"}

# .
# .
# .
# Omitted

2. Install and updatepipenv install --dev and pipenv update

3. Run pipevn run python path-to/test.py

Publish on pypi.org

1.Create dist files:

pipenv run python setup.py sdist bdist_wheel

2.Check dist files:

twine check dist/*

3.Publish on pypi.org:

twine upload dist/*

TODO

• Add version one version manager (https://packaging.python.org/guides/single-sourcing-package-version/#single-sourcing-the-version)
• Add properly test

 External documentation used

1. Distributing packages Official documentation

2. Real python blog - How to Publish an Open-Source Python Package to PyPI

3. Pipenv documentation

4. Getting Started With Testing in Python