# TaskBOX
A minimal task manager for automated test.
## Install
### PyPI
Install and update using`pip:
```shell
pip install -U taskbox
```
### Repository
When using git, clone the repository and change your PWD.
```shell
git clone http://github.com/mcpcpc/taskbox
cd taskbox/
```
Create and activate a virtual environment.
```shell
python3 -m venv venv
source venv/bin/activate
```
Install TaskBOX to the virtual environment.
```shell
pip install -e .
```
## Commands
### db-init
The Sqlite3 database can be initialized or re-initialized with the
following command.
```shell
flask --app taskbox init-db
```
## Deployment
Before deployment, we *strongly* encourage you to override the
default `SECRET_KEY` variable. This can be done by creating a
`conf.py` file and placing it in the same root as the instance (i.e. typically where the SQLite database resides).
```python
SECRET_KEY = “192b9bdd22ab9ed4d12e236c78afcb9a393ec15f71bbf5dc987d54727823bcbf“
```
There are a number of ways to generate a secret key value. The
simplest would be to use the built-in secrets Python library.
```shell
$ python -c ‘import secrets; print(secrets.token_hex())’
‘192b9bdd22ab9ed4d12e236c78afcb9a393ec15f71bbf5dc987d54727823bcbf’
```
### Waitress
Production WSGI via waitress.
```shell
pip install waitress
waitress-serve --call taskbox:create_app
```
## Test
```shell
python3 -m unittest
```
Run with coverage report.
```shell
coverage run -m pytest
coverage report
coverage html # open htmlcov/index.html in a browser
```
Raw data
{
"_id": null,
"home_page": "https://github.com/mcpcpc/taskbox",
"name": "taskbox",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "flask,automation,test,framework,wsgi",
"author": "Michael Czigler",
"author_email": "contact@mcpcpc.com",
"download_url": "https://files.pythonhosted.org/packages/e6/c7/b731a0160f820f94e0bad8277cb9810a77b24de412428611029dcdc3b6c1/taskbox-0.1.0.tar.gz",
"platform": null,
"description": "# TaskBOX\n\nA minimal task manager for automated test.\n\n## Install\n\n### PyPI\n\nInstall and update using`pip:\n\n```shell\npip install -U taskbox\n```\n\n### Repository\n\nWhen using git, clone the repository and change your PWD.\n\n```shell\ngit clone http://github.com/mcpcpc/taskbox\ncd taskbox/\n```\n\nCreate and activate a virtual environment.\n\n```shell\npython3 -m venv venv\nsource venv/bin/activate\n```\n\nInstall TaskBOX to the virtual environment.\n\n```shell\npip install -e .\n```\n\n## Commands\n\n### db-init\n\nThe Sqlite3 database can be initialized or re-initialized with the\nfollowing command.\n\n```shell\nflask --app taskbox init-db\n```\n\n## Deployment\n\nBefore deployment, we *strongly* encourage you to override the\ndefault `SECRET_KEY` variable. This can be done by creating a\n`conf.py` file and placing it in the same root as the instance (i.e. typically where the SQLite database resides).\n\n```python\nSECRET_KEY = \u201c192b9bdd22ab9ed4d12e236c78afcb9a393ec15f71bbf5dc987d54727823bcbf\u201c\n```\n\nThere are a number of ways to generate a secret key value. The\nsimplest would be to use the built-in secrets Python library.\n\n```shell\n$ python -c \u2018import secrets; print(secrets.token_hex())\u2019\n\u2018192b9bdd22ab9ed4d12e236c78afcb9a393ec15f71bbf5dc987d54727823bcbf\u2019\n```\n\n### Waitress\n\nProduction WSGI via waitress.\n\n```shell\npip install waitress\nwaitress-serve --call taskbox:create_app\n```\n\n## Test\n\n```shell\npython3 -m unittest\n```\n\nRun with coverage report.\n\n```shell\ncoverage run -m pytest\ncoverage report\ncoverage html # open htmlcov/index.html in a browser\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A minimal task manager for automated test.",
"version": "0.1.0",
"split_keywords": [
"flask",
"automation",
"test",
"framework",
"wsgi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b088283f7b14613429342d1e00ecbc51183057fe978f8598066028eb281c18cc",
"md5": "0a10b27e9ed0fa78afadf8f60ec77292",
"sha256": "b675226e4578fc85f7deb79b8d5e62cece760c97ee3f799dff910dbd8aa9fcd1"
},
"downloads": -1,
"filename": "taskbox-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a10b27e9ed0fa78afadf8f60ec77292",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 23077,
"upload_time": "2023-01-15T03:50:57",
"upload_time_iso_8601": "2023-01-15T03:50:57.751475Z",
"url": "https://files.pythonhosted.org/packages/b0/88/283f7b14613429342d1e00ecbc51183057fe978f8598066028eb281c18cc/taskbox-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e6c7b731a0160f820f94e0bad8277cb9810a77b24de412428611029dcdc3b6c1",
"md5": "0a1ab97af675d72a63742e062fbf4902",
"sha256": "122fa02f8c854d0000c0be4e8c6620fb7e61920737b698ab4e1fea38e383867b"
},
"downloads": -1,
"filename": "taskbox-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0a1ab97af675d72a63742e062fbf4902",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15263,
"upload_time": "2023-01-15T03:50:58",
"upload_time_iso_8601": "2023-01-15T03:50:58.998869Z",
"url": "https://files.pythonhosted.org/packages/e6/c7/b731a0160f820f94e0bad8277cb9810a77b24de412428611029dcdc3b6c1/taskbox-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-15 03:50:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mcpcpc",
"github_project": "taskbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "taskbox"
}
JSON
