A library of custom computer vision models.
Project description
Introduction
A library of custom computer vision models.
See documentation for details.
Installation
Python
pip install flatiron
Docker
- Install docker-desktop
docker pull thenewflesh/flatiron:[version]
Docker For Developers
- Install docker-desktop
- Ensure docker-desktop has at least 4 GB of memory allocated to it.
git clone git@github.com:thenewflesh/flatiron.git
cd flatiron
chmod +x bin/flatiron
bin/flatiron start
The service should take a few minutes to start up.
Run bin/flatiron --help
for more help on the command line tool.
Production CLI
flatiron comes with a command line interface defined in command.py.
Its usage pattern is: flatiron COMMAND [ARGS] [FLAGS] [-h --help]
Commands
bash-completion
Prints BASH completion code to be written to a _flatiron completion file
Usage: flatiron bash-completion
zsh-completion
Prints ZSH completion code to be written to a _flatiron completion file
Usage: flatiron zsh-completion
Development CLI
bin/flatiron is a command line interface (defined in cli.py) that works with any version of python 2.7 and above, as it has no dependencies.
Its usage pattern is: bin/flatiron COMMAND [-a --args]=ARGS [-h --help] [--dryrun]
Commands
Command | Description |
---|---|
build-package | Build production version of repo for publishing |
build-prod | Publish pip package of repo to PyPi |
build-publish | Run production tests first then publish pip package of repo to PyPi |
build-test | Build test version of repo for prod testing |
docker-build | Build image of flatiron |
docker-build-prod | Build production image of flatiron |
docker-container | Display the Docker container id of flatiron |
docker-coverage | Generate coverage report for flatiron |
docker-destroy | Shutdown flatiron container and destroy its image |
docker-destroy-prod | Shutdown flatiron production container and destroy its image |
docker-image | Display the Docker image id of flatiron |
docker-prod | Start flatiron production container |
docker-push | Push flatiron production image to Dockerhub |
docker-remove | Remove flatiron Docker image |
docker-restart | Restart flatiron container |
docker-start | Start flatiron container |
docker-stop | Stop flatiron container |
docs | Generate sphinx documentation |
docs-architecture | Generate architecture.svg diagram from all import statements |
docs-full | Generate documentation, coverage report, diagram and code |
docs-metrics | Generate code metrics report, plots and tables |
library-add | Add a given package to a given dependency group |
library-graph-dev | Graph dependencies in dev environment |
library-graph-prod | Graph dependencies in prod environment |
library-install-dev | Install all dependencies into dev environment |
library-install-prod | Install all dependencies into prod environment |
library-list-dev | List packages in dev environment |
library-list-prod | List packages in prod environment |
library-lock-dev | Resolve dev.lock file |
library-lock-prod | Resolve prod.lock file |
library-remove | Remove a given package from a given dependency group |
library-search | Search for pip packages |
library-sync-dev | Sync dev environment with packages listed in dev.lock |
library-sync-prod | Sync prod environment with packages listed in prod.lock |
library-update | Update dev dependencies |
session-lab | Run jupyter lab server |
session-python | Run python session with dev dependencies |
state | State of flatiron |
test-coverage | Generate test coverage report |
test-dev | Run all tests |
test-fast | Test all code excepts tests marked with SKIP_SLOWS_TESTS decorator |
test-lint | Run linting and type checking |
test-prod | Run tests across all support python versions |
version | Full resolution of repo: dependencies, linting, tests, docs, etc |
version-bump-major | Bump pyproject major version |
version-bump-minor | Bump pyproject minor version |
version-bump-patch | Bump pyproject patch version |
zsh | Run ZSH session inside flatiron container |
zsh-complete | Generate oh-my-zsh completions |
zsh-root | Run ZSH session as root inside flatiron container |
Flags
Short | Long | Description |
---|---|---|
-a | --args | Additional arguments, this can generally be ignored |
-h | --help | Prints command help message to stdout |
--dryrun | Prints command that would otherwise be run to stdout |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file flatiron-0.14.1.tar.gz
.
File metadata
- Download URL: flatiron-0.14.1.tar.gz
- Upload date:
- Size: 20.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.4.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 351560446e6cdeff4c26cc407a1930bd587e82b2020ec056b7ee3fe2b80daa04 |
|
MD5 | b3701bc2c990fcb7f9d936fbd9f245f8 |
|
BLAKE2b-256 | cc0201cf6f4de7f9c50cbaa676ae5a25f5a866b04eb509062c125df8b7ed9de0 |
File details
Details for the file flatiron-0.14.1-py3-none-any.whl
.
File metadata
- Download URL: flatiron-0.14.1-py3-none-any.whl
- Upload date:
- Size: 24.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.4.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1824f6b2ff8ca74dcbb8c0fdfe7778b9ca6d8f2083450979898f372287bdd4d1 |
|
MD5 | 4f70e74e79f74e46a720ab3cedcd099d |
|
BLAKE2b-256 | 649bf62cb59763ffab9a63e78e4823190871e0c8dd0ee028e634e508fa990eca |