Skip to content

Maintaining.md

Latest commit

 

History

History
39 lines (31 loc) · 1.37 KB

Maintaining.md

File metadata and controls

39 lines (31 loc) · 1.37 KB
Raw

Warning: This note is for developer/maintainer of this package only

Updating Package

  • If from scratch, using pipenv
    • Install pipenv pip install pipenv or pip3 install pipenv
    • CD to project directory
    • Install using pipenv pipenv install
    • Activate and enter python env for current folder pipenv shell, now you are inside python env
    • Install project as local package pip install -e .
  • Make your code changes
  • Increase version value on ./setup.py file
  • To install the package locally with a symlink pip install -e .
  • To run test, run pytest
    • To run specific test, e.g: pytest -k "test_core_api_charge_fail_401"
  • To update https://pypi.org repo, run these on terminal:
# install setuptools & wheel
python -m pip install --upgrade setuptools wheel

# Generate `dist/` folder for upload
python setup.py sdist bdist_wheel

# Update / install Twine
python -m pip install --upgrade twine;

# upload to pypi / pip repository
# you will be asked for username and password for https://pypi.org account
twine upload dist/*;

# To upload to test pypi use this instead
# twine upload --repository-url https://test.pypi.org/legacy/ dist/*;

Dev & Test via Docker Compose

  • To use docker-compose to test and run project, cd to repo dir
  • Run docker-compose up, which basically run pytest on container
  • Run docker-compose down, to clean up when done