Opsy

It's Opsy! A simple multi-user/role operations inventory system with aspirations.

Developing

It's recommended to use a virtual environment for development.

$ mkvirtualenv -p /usr/bin/python3.6 opsy

Clone down the opsy repo:

$ git clone git@github.com:testeddoughnut/opsy.git

Install opsy for development (ensure you are in your previously created virtualenv):

$ pip install --editable .

Create opsy.toml by copying the example config:

$ cp opsy.toml.example opsy.toml

Initialize the DB, the example config uses sqlite by default for development:

$ opsyctl db upgrade

You can now create your admin user and set its password, create a role, then add the user to the role:

$ opsyctl create-admin-user

Each route is protected by a permission for that route. You can get a full list of the permissions by running opsyctl permission-list. Permissions are granted to roles and users gain access to permissions by being in roles. The admin user and role created with the last command are automatically granted full permissions.

We are now ready to start opsy for the first time:

$ opsyctl run

By default it listens on http://127.0.0.1:5000/. You can access the auto generated swagger docs by navigating to http://127.0.0.1:5000/docs/.

Dealing with schema changes

If you are introducing a change that requires a schema change you must create a schema revision. This can be done like so:

$ opsyctl db migrate

This will autogenerate a new revision file under migrations/versions/. Please review the resulting file and make any changes necessary to account for changes that Alembic doesn't do a good job of detecting (things like table renames). Please review the following documentation for more information: https://alembic.sqlalchemy.org/en/latest/autogenerate.html#what-does-autogenerate-detect-and-what-does-it-not-detect

If you are upgrading Opsy and need to migrate to a newer version of the schema you can run the following:

$ opsyctl db upgrade