There Otter be an Otter scaling system.
This codebase is not able to be deployed independently. The code is open source as a reference, but requires dependencies not available within this repository.
Talk with us! Join us in:
Otter Dev Hall of Fame (alphabetical):
make hooksto set up pre-commit hooks for the project (PLEASE RUN THIS IF DEVELOPING ON THE PROJECT)
Build an environment:
make env-precheckmakes sure you have enough pre-existing infrastructure to be able to run
make envto begin with.
make envcreates and switches into the Python virtualenv environment. It'll also pip-install development requirements.
Run tests, check code quality:
make testruns both unit and integration tests.
make unitruns unit tests.
make integrationruns integration tests.
make coverageperforms coverage analysis.
make lintperforms a lint (PEP8, et. al.) check on the source code.
make listoutdatedreturns the packages that are currently installed that have new versions available on PyPI. This is normally run as a part of
make flake8difflooks at the diff introduced by your current branch and lints it. This is normally run as a part of
make flake8fullis like
flake8diff, except on the entire repository.
Build the documentation:
make docsbuilds all other documentation targets (listed below).
make sphinxdocsbuilds all Sphinx documentation.
make docbookbuilds all user-facing Docbook documentation.
make bundlebuilds a "bundle" appropriate for deployment (Ubuntu only). For Jenkins and Chef use only.
make runstarts up an instance of the Otter API.
make cleandocsremoves all documentation artifacts without removing other artifacts.
make cleanremoves all build-time artifacts, leaving the repository in a distributable state.
Build and migrate Cassandra schemata
Some tools for building Cassandra schemata as CQL files:
make schema-setupgenerates the setup CQL files.
make schema-teardowngenerates the teardown CQL files.
make schemagenerates the CQL files corresponding to setting up and tearing down Otter's Cassandra schema. Equivalent to running
make schema-setup schema-teardownmanually.
Some tools for applying Cassandra schemata (by default, these are
localhost, because they're typically only used within the
make load-dev-schemawill attempt to load the development schema into Cassandra.
make migrate-dev-schemawill attempt to update the development schema on an existing Cassandra instance.
make teardown-dev-schemawill attempt to remove a development schema from an existing Cassandra instance.
make clear-dev-schemafirst removes any existing development schema, then re-installs a fresh schema.