# DataBurglar
<p>
<b>SOMETHING</b> happened at <b>SOMETIME</b> and we would like to <b>STORE</b> it in <b>Postgres</b>.
</p>
<hr />
### 1. Install
```
pip install databurglar
```
### 2. Include Tables
```python
from databurglar.models import setup_data_collection, setup_surveys
engine: Engine = ...
## setup tables to collect data based on a `UserEvent`
setup_data_collection(
engine,
UserEvent
)
## <optional>: setup tables to build dynamic data collection forms/surveys
setup_surveys(engine)
```
### 3. Queries
### 4. Commands
## Local Project Development
#### windows
```
python -m venv env
.\env\Scripts\activate
pip install -r requirements.txt
```
Raw data
{
"_id": null,
"home_page": "https://github.com/dpasse/databurglar",
"name": "databurglar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12.5",
"maintainer_email": null,
"keywords": "Data Collection, SqlAlchemy",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/cc/83/1385504d328d85c543a7d7c0e7eb520a6e4007b2be60bc147934037fd452/databurglar-0.0.3.tar.gz",
"platform": null,
"description": "# DataBurglar\r\n\r\n<p>\r\n <b>SOMETHING</b> happened at <b>SOMETIME</b> and we would like to <b>STORE</b> it in <b>Postgres</b>.\r\n</p>\r\n\r\n<hr />\r\n\r\n### 1. Install\r\n\r\n```\r\n pip install databurglar\r\n```\r\n\r\n### 2. Include Tables\r\n```python\r\nfrom databurglar.models import setup_data_collection, setup_surveys\r\n\r\nengine: Engine = ...\r\n\r\n## setup tables to collect data based on a `UserEvent`\r\nsetup_data_collection(\r\n engine,\r\n UserEvent\r\n)\r\n\r\n## <optional>: setup tables to build dynamic data collection forms/surveys\r\nsetup_surveys(engine)\r\n```\r\n\r\n### 3. Queries\r\n\r\n### 4. Commands\r\n\r\n\r\n\r\n## Local Project Development\r\n#### windows\r\n```\r\n python -m venv env\r\n .\\env\\Scripts\\activate\r\n\r\n pip install -r requirements.txt\r\n```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "SQLAlchemy Package for data tracking.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/dpasse/databurglar"
},
"split_keywords": [
"data collection",
" sqlalchemy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a1351dfc590053f15045d77d8e019d241d5c1e2ba04039a6f2b5b70a9b75078",
"md5": "f158ef940678246a47b702af29e0384b",
"sha256": "e649f65544672f23540934714d8b7a69133347246745038efe8c627f739da7db"
},
"downloads": -1,
"filename": "databurglar-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f158ef940678246a47b702af29e0384b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12.5",
"size": 12041,
"upload_time": "2024-08-23T10:49:44",
"upload_time_iso_8601": "2024-08-23T10:49:44.401243Z",
"url": "https://files.pythonhosted.org/packages/5a/13/51dfc590053f15045d77d8e019d241d5c1e2ba04039a6f2b5b70a9b75078/databurglar-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cc831385504d328d85c543a7d7c0e7eb520a6e4007b2be60bc147934037fd452",
"md5": "4fd3f9753b6b2c2f3826d187e23b6e5a",
"sha256": "f98485c39659ff40b9bb34062aef929f854f391ee6946f715217a9d8a44760a7"
},
"downloads": -1,
"filename": "databurglar-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "4fd3f9753b6b2c2f3826d187e23b6e5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12.5",
"size": 7215,
"upload_time": "2024-08-23T10:49:45",
"upload_time_iso_8601": "2024-08-23T10:49:45.590616Z",
"url": "https://files.pythonhosted.org/packages/cc/83/1385504d328d85c543a7d7c0e7eb520a6e4007b2be60bc147934037fd452/databurglar-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 10:49:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dpasse",
"github_project": "databurglar",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"2.0.32"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.8"
]
]
},
{
"name": "psycopg2",
"specs": [
[
"==",
"2.9.9"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"8.3.2"
]
]
},
{
"name": "pyclean",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "mypy",
"specs": [
[
"==",
"1.11.1"
]
]
},
{
"name": "wheel",
"specs": [
[
"==",
"0.44.0"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"5.1.1"
]
]
},
{
"name": "pylint",
"specs": [
[
"==",
"3.2.6"
]
]
},
{
"name": "setuptools",
"specs": [
[
"==",
"72.2.0"
]
]
}
],
"lcname": "databurglar"
}
JSON
