Why `ULTRON-8`?

Welcome to `ultron8` Documentation

Documentation for ultron8.

Install

ultron8 is released on PyPI, so all you need is:

$ pip install ultron8

To upgrade to latest version:

$ pip install --upgrade ultron8

Local Testing

ultron8 can be tested locally if you have all of the correct dependencies installed, simply run:

$ pipenv run pip install -e .

To run local tests, first start up the web server:

$ make serve-daemon

Then run pytest using our wrapper script:

$ make ci-local

Resources

https://www.reddit.com/r/PhotoshopRequest/comments/a7fzua/specific_photoshop_this_picture_of_ultron/

Project structure

.
├── bin                            - small utility executables
├── contrib                        - user contributions
├── docs                           - documentation
├── example_notebooks              - notebooks to better understand how fastapi works
├── git_hooks                      - git hookes for contributors
├── hacking                        - local development scripts for manipulating project
├── images                         - repo images
├── lint-configs-python            - linter files
│   └── python                     - pylintrc, mypy, etc configs
├── make                           - make tasks
├── script                         - utility scripts, for ci etc
├── tasks                          - pyinvoke python scripts
├── tests                          - (tests) pytest
│   ├── api                        - (tests) web related stuff
│   │   ├── api_v1                 - (tests)
│   │   ├── crud                   - (tests)
│   │   └── utils                  - (tests)
│   ├── commands                   - (tests)
│   ├── config                     - (tests)
│   ├── constants                  - (tests)
│   ├── core                       - (tests)
│   ├── fixtures                   - (tests)
│   │   ├── isolated_config_dir    - (tests)
│   │   └── simple                 - (tests)
│   │       └── packs              - (tests)
│   │
│   ├── ssl                        - (tests)
│   ├── u8client                   - (tests)
│   │   └── models                 - (tests)
│   └── utils                      - (tests)
│
│
│
│
├── ultron8                        - application folder
│   ├── api                        - web related stuff
│   │   ├── api_v1                 - v1 web api
│   │   │   └── endpoints          - web routes
│   │   ├── core                   - application configuration, statup events, logging
│   │   │   ├── base               -
│   │   │   ├── pagination         -
│   │   │   └── trigger            -
│   │   ├── crud                   - all crud stuff
│   │   ├── db                     - db related stuff
│   │   │   ├── pagination         -
│   │   │   └── u_sqlite           -
│   │   ├── db_models              - sqlalchemy database models
│   │   ├── depends                - dependencies for routes definition.
│   │   ├── email-templates        - email templates
│   │   │   └── src                -
│   │   ├── factories              - factories
│   │   ├── middleware             - fastapi custom middlewares
│   │   │   └── logging            -
│   │   ├── models                 - pydantic models for this application.
│   │   │   └── system             -
│   │   │
│   │   ├── templates              - fastapi templates
│   │   ├── utils                  - fastapi utils
│   │   └── views                  - fastapi views
│   │
│   ├── commands                   - click commands for ultronctl
│   ├── config                     - ultronctl config functions
│   ├── constants                  - project wide constants
│   ├── core                       - click commands core
│   ├── docs                       - (to be deleted) ????????????
│   ├── exceptions                 - apllication exceptions
│   ├── migrations                 - alembic migrations
│   ├── serialize                  - functions and classes responsible for converting structured data to a format that allows sharing of data.
│   │   └── runstate               -
│   ├── static                     - more images
│   ├── u8client                   - ultron8 client used for programatic api calls ( base on github3.py )
│   │   ├── models                 - ( base on github3.py )
│   │   ├── structs                - ( base on github3.py )
│   │   └── utils                  - ( base on github3.py )
│   └── utils                      - global utils
└── vagrant                        -

Name		Name	Last commit message	Last commit date
Latest commit History 187 Commits
.ci		.ci
.ropeproject		.ropeproject
.vscode		.vscode
bash		bash
bin		bin
contrib		contrib
docs		docs
example-cluster		example-cluster
example_notebooks		example_notebooks
examples/packs/chatops_tutorial		examples/packs/chatops_tutorial
extras		extras
git_hooks		git_hooks
hacking		hacking
images		images
lint-configs-python		lint-configs-python
make		make
script		script
tasks		tasks
tests		tests
ultron8		ultron8
vagrant		vagrant
.coveragerc		.coveragerc
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.env.dist		.env.dist
.env.dist.sample		.env.dist.sample
.gitattributes		.gitattributes
.gitignore		.gitignore
.hadolint.yaml		.hadolint.yaml
.local.dist		.local.dist
.pre-commit-config.yaml		.pre-commit-config.yaml
.readthedocs.yml		.readthedocs.yml
.tmuxinator.yml		.tmuxinator.yml
.travis.yml		.travis.yml
AUTHORS.rst		AUTHORS.rst
CONTRIBUTING.md		CONTRIBUTING.md
DRAFT_README.md		DRAFT_README.md
Dockerfile		Dockerfile
Dockerfile.cached		Dockerfile.cached
Dockerfile.celeryworker		Dockerfile.celeryworker
Dockerfile.dev		Dockerfile.dev
LICENSE		LICENSE
LICENSE.txt		LICENSE.txt
MANIFEST.in		MANIFEST.in
Makefile		Makefile
Pipfile.bak		Pipfile.bak
README.rst		README.rst
TESTING.md		TESTING.md
TODO.md		TODO.md
Vagrantfile		Vagrantfile
alembic.ini		alembic.ini
ansible.cfg		ansible.cfg
client-testing-notebook.ipynb		client-testing-notebook.ipynb
dev-bashrc.sh		dev-bashrc.sh
docker-compose.base.yml		docker-compose.base.yml
docker-compose.cached.yml		docker-compose.cached.yml
docker-compose.celeryworker.yml		docker-compose.celeryworker.yml
docker-compose.ci.yml		docker-compose.ci.yml
docker-compose.rabbitmq.yml		docker-compose.rabbitmq.yml
docker-compose.web.yml		docker-compose.web.yml
fixcode.py		fixcode.py
gunicorn_conf.py		gunicorn_conf.py
inventory.ini		inventory.ini
invoke.yaml		invoke.yaml
itest.sh		itest.sh
oop-analysis.md		oop-analysis.md
playbook.yml		playbook.yml
python-style-guid.en.md		python-style-guid.en.md
python-versions.txt		python-versions.txt
readthedocs.yml		readthedocs.yml
release-history.rst		release-history.rst
requirements-dev.in		requirements-dev.in
requirements-dev.txt		requirements-dev.txt
requirements-doc.in		requirements-doc.in
requirements-doc.txt		requirements-doc.txt
requirements-experimental.in		requirements-experimental.in
requirements-experimental.txt		requirements-experimental.txt
requirements-perf.in		requirements-perf.in
requirements-test.in		requirements-test.in
requirements-test.txt		requirements-test.txt
requirements.in		requirements.in
requirements.txt		requirements.txt
requirements.yml		requirements.yml
schema.md		schema.md
setup.cfg		setup.cfg
setup.py		setup.py
start-gunicorn.sh		start-gunicorn.sh
start-reload-gunicorn.sh		start-reload-gunicorn.sh
test_payload.json		test_payload.json
tox.ini		tox.ini
travis_pypi_setup.py		travis_pypi_setup.py
try.md		try.md
vagrant-config.yml		vagrant-config.yml
vagrant_playbook.yml		vagrant_playbook.yml

License

Licenses found

bossjones/ultron8

Folders and files

Latest commit

History