titan-zeus 0b0

No project description provided

zeus

Docs are still lagging...

What is this?

This is a collection of tools extracted from a multi-project django monolith. Because we're new to publishing packages, there are a few gotchas:

• This is a monolithic package/install. Consumers can't just install a part, but must install the entire thing.
  • This also means the whole thing is versioned together. If we add a shiny new feature after a totally independent breaking change, consumers can't get the new feature without the breaking change.
• This tool doesn't include external dependencies, you will have to install those yourself. We did this so consumers don't need to install packages they may not use.

List of packages and utilities

Utils are grouped by the following package names. That means you import them as so:

from zeus.vanilla import is_ascii

vanilla

• is_ascii
• are_strings_close_enough
• group_by

versioning

versioning model behaviour has no external dependencies.

Subclassing versioning.core.VersionModel will create a history model that is automatically updated on each save. See the example

changelog (in progress)

changelogs requires many external dependencies: graphene, aiodataloader, graphene-django

creating changelogs currently require a lot of boilerplate code.

TODO: create a function that abstracts away all the graphql and allows querying paginated changelog data for specific models, fields, users and dates.

i18n

Depends on django, bleach, mistune and pyyaml

• TextMakerCreator(global_keys,text_file_paths)
• WatchingTextMakerCreator((global_keys,text_file_paths)
  • if using runserver and settings.DEBUG=True, requires watchdog

markdown

requires django, bleach and mistune to be installed

• markdown
• is_md_valid
• sanitize_html

How to build dist and egginfo

# in this project:
python setup.py sdist

How to install this locally without pypi (test this right before deploying a new version)

editable mode

When refreshing a local package, you'll also need pip uninstall -y zeus in between installs. This is super annoying, fortunately there's an easier way for python to link directly to the sources so this isn't necessary:

pip uninstall zeus

# then replace zeus in requirements.txt with the following
# -e file:///absolute/path/to/zeus/

locally packaged mode

Once you've got something that work in editable mode, try packaging the app

# in zeus project
python setup.py sdist

# in consumer project
pip uninstall -y zeus
# replace the zeus entry in requirements.txt with 
#file:///absolute/path/to/zeus/

Installing from git with branch (primary way)

the entry in requirements.txt should look like this

git+git://github.com/TBS-EACPD/zeus@release-0.1#egg=zeus

To update zeus, you'll need to pip uninstall -y zeus before re-running your pip install -r requirements.txt

Development

TODO: get postgres, CI, etc. configured in a similar fashion to titan

The development environment should similar to the OG titan

1. Install postgres postgres 9.6 and configure your $PATH
2. Set up the virtual environment
3. run createdb zeus-dev

Releases

At this point, consumers just use git reference in their requirements.txt to install zeus. Instead of tagging commits with git tags, which github can't protect, we use branches. To create a release, create a new branch release-<MAJOR>-<MINOR>-<PATCH> and push it up.

If you're adding a feature, the recommended flow is to

1. Open up a feature branch (e.g. branch my-feature)
2. get your PR approved and merged into master
3. Create a release branch from master and push it up.