| Name | oracle-object-tracker JSON |
| Version |
0.0.9
JSON |
| download |
| home_page | None |
| Summary | A Python-based tool for tracking Oracle database object DDL with git |
| upload_time | 2024-10-14 17:44:38 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
oracle
object
tracker
git
ddl
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Oracle Object Tracker
[<img src="https://img.shields.io/badge/GitHub-TruckCab%2Foracle--object--tracker-blue.svg?logo=Github">](https://github.com/TruckCab/oracle-object-tracker)
[](https://github.com/TruckCab/oracle-object-tracker/actions/workflows/ci.yml)
[](https://pypi.org/project/sidewinder-db/)
[](https://badge.fury.io/py/oracle-object-tracker)
[](https://pypi.org/project/oracle-object-tracker/)
## Install package
You can install `oracle-object-tracker` from source.
### Option 1 - from PyPi
```shell
# Create the virtual environment
python3 -m venv .venv
# Activate the virtual environment
. .venv/bin/activate
pip install oracle-object-tracker
```
### Option 2 - from source - for development
```shell
git clone https://github.com/TruckCab/oracle-object-tracker.git
cd oracle-object-tracker
# Create the virtual environment
python3 -m venv .venv
# Activate the virtual environment
. .venv/bin/activate
# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
# Install Sidewinder-DB - in editable mode with dev dependencies
pip install --editable .[dev]
```
### Note
For the following commands - if you running from source and using `--editable` mode (for development purposes) - you will need to set the PYTHONPATH environment variable as follows:
```shell
export PYTHONPATH=$(pwd)/src
```
## Usage
### Help
```shell
oracle-object-tracker --help
Usage: oracle-object-tracker [OPTIONS]
Options:
--version / --no-version Prints the Oracle Object Tracker version and
exits. [required]
--username TEXT The Oracle database username to connect
with. [required]
--password TEXT The Oracle database password to connect
with. [required]
--hostname TEXT The Oracle database hostname to connect to.
[required]
--service-name TEXT The Oracle database service name to connect
to. [required]
--port INTEGER The Oracle database port to connect to.
[required]
--schema TEXT The schema to export objects for, may be
specified more than once. Defaults to the
database username. [required]
--object-type TEXT The object types to export. [default:
CLUSTER, DATABASE LINK, FUNCTION, INDEX,
JAVA SOURCE, JOB, MATERIALIZED VIEW,
MATERIALIZED VIEW LOG, PACKAGE, PACKAGE
BODY, PROCEDURE, SEQUENCE, SYNONYM, TABLE,
TRIGGER, TYPE, TYPE BODY, VIEW; required]
--object-name-include-pattern TEXT
The regexp pattern to use to filter object
names to include in the export. [default:
.*; required]
--object-name-exclude-pattern TEXT
The regexp pattern to use to filter object
names to exclude in the export.
--output-directory TEXT The path to the output directory - may be
relative or absolute. [default: /var/folder
s/c8/b5pj7nzx627_9tbw374v3r1h0000gn/T/output
; required]
--overwrite BOOLEAN Controls whether to overwrite any existing
DDL export files in the output path.
[default: False; required]
--git-repo TEXT Allows you to specify a git repository to
push the output files to. The repository
must be accessible via SSH. Example:
git@github.com:some-org/some-repo.git See: h
ttps://docs.github.com/en/authentication/con
necting-to-github-with-ssh/adding-a-new-ssh-
key-to-your-github-account for more
information on setting up SSH keys for
GitHub.
--git-branch TEXT Specify the git branch to push to - if the
--git-repo arg is used. [default: main]
--log-level TEXT The logging level to use for the
application. [default: INFO; required]
--help Show this message and exit.
```
## Handy development commands
#### Version management
##### Bump the version of the application - (you must have installed from source with the [dev] extras)
```bash
bumpver update --patch
```
Raw data
{
"_id": null,
"home_page": null,
"name": "oracle-object-tracker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "oracle, object, tracker, git, ddl",
"author": null,
"author_email": "Philip Moore <prmoore77@hotmail.com>, Stephen Weber <sweber@truckcab.com>",
"download_url": "https://files.pythonhosted.org/packages/35/78/6bcb91527a6656393400dde86b44a62b7bce14449e582d6296e6f0555243/oracle_object_tracker-0.0.9.tar.gz",
"platform": null,
"description": "# Oracle Object Tracker\n\n[<img src=\"https://img.shields.io/badge/GitHub-TruckCab%2Foracle--object--tracker-blue.svg?logo=Github\">](https://github.com/TruckCab/oracle-object-tracker)\n[](https://github.com/TruckCab/oracle-object-tracker/actions/workflows/ci.yml)\n[](https://pypi.org/project/sidewinder-db/)\n[](https://badge.fury.io/py/oracle-object-tracker)\n[](https://pypi.org/project/oracle-object-tracker/)\n\n## Install package\nYou can install `oracle-object-tracker` from source.\n\n### Option 1 - from PyPi\n```shell\n# Create the virtual environment\npython3 -m venv .venv\n\n# Activate the virtual environment\n. .venv/bin/activate\n\npip install oracle-object-tracker\n```\n\n### Option 2 - from source - for development\n```shell\ngit clone https://github.com/TruckCab/oracle-object-tracker.git\n\ncd oracle-object-tracker\n\n# Create the virtual environment\npython3 -m venv .venv\n\n# Activate the virtual environment\n. .venv/bin/activate\n\n# Upgrade pip, setuptools, and wheel\npip install --upgrade pip setuptools wheel\n\n# Install Sidewinder-DB - in editable mode with dev dependencies\npip install --editable .[dev]\n```\n\n### Note\nFor the following commands - if you running from source and using `--editable` mode (for development purposes) - you will need to set the PYTHONPATH environment variable as follows:\n```shell\nexport PYTHONPATH=$(pwd)/src\n```\n\n## Usage\n### Help\n```shell\noracle-object-tracker --help\nUsage: oracle-object-tracker [OPTIONS]\n\nOptions:\n --version / --no-version Prints the Oracle Object Tracker version and\n exits. [required]\n --username TEXT The Oracle database username to connect\n with. [required]\n --password TEXT The Oracle database password to connect\n with. [required]\n --hostname TEXT The Oracle database hostname to connect to.\n [required]\n --service-name TEXT The Oracle database service name to connect\n to. [required]\n --port INTEGER The Oracle database port to connect to.\n [required]\n --schema TEXT The schema to export objects for, may be\n specified more than once. Defaults to the\n database username. [required]\n --object-type TEXT The object types to export. [default:\n CLUSTER, DATABASE LINK, FUNCTION, INDEX,\n JAVA SOURCE, JOB, MATERIALIZED VIEW,\n MATERIALIZED VIEW LOG, PACKAGE, PACKAGE\n BODY, PROCEDURE, SEQUENCE, SYNONYM, TABLE,\n TRIGGER, TYPE, TYPE BODY, VIEW; required]\n --object-name-include-pattern TEXT\n The regexp pattern to use to filter object\n names to include in the export. [default:\n .*; required]\n --object-name-exclude-pattern TEXT\n The regexp pattern to use to filter object\n names to exclude in the export.\n --output-directory TEXT The path to the output directory - may be\n relative or absolute. [default: /var/folder\n s/c8/b5pj7nzx627_9tbw374v3r1h0000gn/T/output\n ; required]\n --overwrite BOOLEAN Controls whether to overwrite any existing\n DDL export files in the output path.\n [default: False; required]\n --git-repo TEXT Allows you to specify a git repository to\n push the output files to. The repository\n must be accessible via SSH. Example:\n git@github.com:some-org/some-repo.git See: h\n ttps://docs.github.com/en/authentication/con\n necting-to-github-with-ssh/adding-a-new-ssh-\n key-to-your-github-account for more\n information on setting up SSH keys for\n GitHub.\n --git-branch TEXT Specify the git branch to push to - if the\n --git-repo arg is used. [default: main]\n --log-level TEXT The logging level to use for the\n application. [default: INFO; required]\n --help Show this message and exit.\n```\n\n## Handy development commands\n\n#### Version management\n\n##### Bump the version of the application - (you must have installed from source with the [dev] extras)\n```bash\nbumpver update --patch\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python-based tool for tracking Oracle database object DDL with git",
"version": "0.0.9",
"project_urls": {
"Homepage": "https://github.com/prmoore77/oracle-object-tracker"
},
"split_keywords": [
"oracle",
" object",
" tracker",
" git",
" ddl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fae823488db3566fc3bcefba170c31a0fd7ed17e216e83fe987881fa99be6a1d",
"md5": "81b54f5146fc36cc05abf9993bb10514",
"sha256": "af49ecbbd9164c8668af2658392120d3c02264022ea78d6ab805b27a05ebaea1"
},
"downloads": -1,
"filename": "oracle_object_tracker-0.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81b54f5146fc36cc05abf9993bb10514",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8002,
"upload_time": "2024-10-14T17:44:37",
"upload_time_iso_8601": "2024-10-14T17:44:37.237763Z",
"url": "https://files.pythonhosted.org/packages/fa/e8/23488db3566fc3bcefba170c31a0fd7ed17e216e83fe987881fa99be6a1d/oracle_object_tracker-0.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "35786bcb91527a6656393400dde86b44a62b7bce14449e582d6296e6f0555243",
"md5": "5bcadb7269c9888652b06c49cc37a151",
"sha256": "73b7a0faa7286c583dbc48ec96b770c2ce2a87890d6904826be59d8ea7e77ee7"
},
"downloads": -1,
"filename": "oracle_object_tracker-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "5bcadb7269c9888652b06c49cc37a151",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8901,
"upload_time": "2024-10-14T17:44:38",
"upload_time_iso_8601": "2024-10-14T17:44:38.175718Z",
"url": "https://files.pythonhosted.org/packages/35/78/6bcb91527a6656393400dde86b44a62b7bce14449e582d6296e6f0555243/oracle_object_tracker-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-14 17:44:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "prmoore77",
"github_project": "oracle-object-tracker",
"github_not_found": true,
"lcname": "oracle-object-tracker"
}
