Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.2 KB

DEVELOPING.md

File metadata and controls

40 lines (29 loc) · 1.2 KB

Developing

  1. git clone git@github.com:adamghill/django-unicorn.git
  2. cd django-unicorn
  3. poetry install -E minify -E docs
  4. poetry run python example/manage.py migrate
  5. poetry run python example/manage.py runserver localhost:8000
  6. Go to localhost:8000 in your browser

To install in another project

  • pip install -e ../django-unicorn
  • add something like django-unicorn = { path="../django-unicorn", develop=true } to other project's pyproject.toml

See docs

  1. poetry run sphinx-autobuild -W docs/source docs/build

Run unittests

  1. poetry run pytest
  2. npm run test

Minify JavaScript

  1. npm install
  2. npm run build

Bump version

  1. Update changelog.md
  2. Update package.json
  3. poetry version major|minor|patch
  4. Run all build processes: poe build
  5. Commit/tag/push version bump
  6. poe publish
  7. Make sure test package can be installed as expected (https://test.pypi.org/project/django-unicorn/)
  8. Make sure live package can be installed as expected (https://pypi.org/project/django-unicorn/)
  9. Create GitHub release and add changelog there
  10. Update django-unicorn.com's version of django-unicorn