| Name | chronovoyage JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | Simple database migration framework. |
| upload_time | 2024-11-17 00:55:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Noritaka IZUMI Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
database
migration
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ChronoVoyage
[](https://pypi.org/project/chronovoyage)
[](https://pypi.org/project/chronovoyage)
[](https://snyk.io/advisor/python/chronovoyage)
Chronovoyage is a simple database migration framework.
[Visit Documentation](https://chronovoyagemigration.net/)
-----
## Table of Contents
- [Simple Usage](#simple-usage)
- [Contributing](#contributing)
- [Security Policy](#security-policy)
- [License](#license)
## Simple Usage
To use MariaDB version, you need the MariaDB development package (`libmariadb-dev` in apt).
```shell
pip install chronovoyage[mariadb]
```
## Usage
First, you should name and initialize a directory.
```shell
chronovoyage init my-project --vendor mariadb
cd my-project
```
Edit `config.json`.
```json
{
"$schema": "https://raw.githubusercontent.com/fairy-select/chronovoyage/main/schema/config.schema.json",
"vendor": "mariadb",
"connection_info": {
"host": "127.0.0.1",
"port": 3306,
"user": "mariadb",
"password": "password",
"database": "test"
}
}
```
Create migration template directory.
```shell
chronovoyage add ddl initial_migration
```
If you create DML,
```shell
chronovoyage add dml second_migration
```
Write up sql to `go.sql`, and rollback sql to `return.sql`.
Then, migrate.
```shell
chronovoyage migrate
```
## Contributing
Please read the following docs before you contribute to this repo:
- [Contributing](CONTRIBUTING.md)
- [Code Of Conduct](CODE_OF_CONDUCT.md)
## Security Policy
We support the latest version based on GitHub's vulnerability alerts.
[Security Policy](SECURITY.md)
## License
`chronovoyage` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
[License](LICENSE.txt)
## Roadmap
- Support for
- [x] Python 3.8 or later
- [ ] Docker
- Database support
- [x] MariaDB
- [ ] MySQL
- [ ] PostgreSQL
- Migration file support
- [x] SQL (.sql)
- [ ] Shell script (.sh)
- Commands
- ~~new~~ init
- [x] Create migration directory and config file
- ~~generate~~ add
- [x] Create migration files from template
- migrate
- [x] To latest
- [x] To specific version
- [x] From the beginning
- [x] From the middle
- --dry-run
- [ ] Show executing SQL
- [ ] Detect ddl or dml
- ~~status~~ current
- [x] Show current migration status
- rollback
- [x] To version
- test
- [ ] Check if every "migrate -> rollback" operation means do nothing for schema
- [ ] If dml, the operation means do nothing for data (including autoincrement num)
- Other
- [x] CLI logging
- [x] Documentation
Raw data
{
"_id": null,
"home_page": null,
"name": "chronovoyage",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "database, migration",
"author": null,
"author_email": "Noritaka IZUMI <noritaka.izumi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5d/30/4c147d81c7647a6dd26f2258a36547c86550176d2c72a2074d756375638b/chronovoyage-0.2.2.tar.gz",
"platform": null,
"description": "# ChronoVoyage\n\n[](https://pypi.org/project/chronovoyage)\n[](https://pypi.org/project/chronovoyage)\n\n[](https://snyk.io/advisor/python/chronovoyage)\n\n\n\nChronovoyage is a simple database migration framework.\n\n[Visit Documentation](https://chronovoyagemigration.net/)\n\n-----\n\n## Table of Contents\n\n- [Simple Usage](#simple-usage)\n- [Contributing](#contributing)\n- [Security Policy](#security-policy)\n- [License](#license)\n\n## Simple Usage\n\nTo use MariaDB version, you need the MariaDB development package (`libmariadb-dev` in apt).\n\n```shell\npip install chronovoyage[mariadb]\n```\n\n## Usage\n\nFirst, you should name and initialize a directory.\n\n```shell\nchronovoyage init my-project --vendor mariadb\ncd my-project\n```\n\nEdit `config.json`.\n\n```json\n{\n \"$schema\": \"https://raw.githubusercontent.com/fairy-select/chronovoyage/main/schema/config.schema.json\",\n \"vendor\": \"mariadb\",\n \"connection_info\": {\n \"host\": \"127.0.0.1\",\n \"port\": 3306,\n \"user\": \"mariadb\",\n \"password\": \"password\",\n \"database\": \"test\"\n }\n}\n```\n\nCreate migration template directory.\n\n```shell\nchronovoyage add ddl initial_migration\n```\n\nIf you create DML,\n\n```shell\nchronovoyage add dml second_migration\n```\n\nWrite up sql to `go.sql`, and rollback sql to `return.sql`.\n\nThen, migrate.\n\n```shell\nchronovoyage migrate\n```\n\n## Contributing\n\nPlease read the following docs before you contribute to this repo:\n\n- [Contributing](CONTRIBUTING.md)\n- [Code Of Conduct](CODE_OF_CONDUCT.md)\n\n## Security Policy\n\nWe support the latest version based on GitHub's vulnerability alerts.\n\n[Security Policy](SECURITY.md)\n\n## License\n\n`chronovoyage` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n\n[License](LICENSE.txt)\n\n## Roadmap\n\n- Support for\n - [x] Python 3.8 or later\n - [ ] Docker\n- Database support\n - [x] MariaDB\n - [ ] MySQL\n - [ ] PostgreSQL\n- Migration file support\n - [x] SQL (.sql)\n - [ ] Shell script (.sh)\n- Commands\n - ~~new~~ init\n - [x] Create migration directory and config file\n - ~~generate~~ add\n - [x] Create migration files from template\n - migrate\n - [x] To latest\n - [x] To specific version\n - [x] From the beginning\n - [x] From the middle\n - --dry-run\n - [ ] Show executing SQL\n - [ ] Detect ddl or dml\n - ~~status~~ current\n - [x] Show current migration status\n - rollback\n - [x] To version\n - test\n - [ ] Check if every \"migrate -> rollback\" operation means do nothing for schema\n - [ ] If dml, the operation means do nothing for data (including autoincrement num)\n- Other\n - [x] CLI logging\n - [x] Documentation\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Noritaka IZUMI Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Simple database migration framework.",
"version": "0.2.2",
"project_urls": {
"Documentation": "https://chronovoyagemigration.net/",
"Issues": "https://github.com/fairy-select/chronovoyage/issues",
"Source": "https://github.com/fairy-select/chronovoyage"
},
"split_keywords": [
"database",
" migration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b2251b9d047b827901025023611e77a4ddcb5c413f4bfbb8fb83cac998b588f",
"md5": "fdc5573625ad470e4236b7ce37b5625e",
"sha256": "6142834e1278d4debda33d13ee13c96437e1f3ab0f5a91d8fb7c9708b09099be"
},
"downloads": -1,
"filename": "chronovoyage-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fdc5573625ad470e4236b7ce37b5625e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 28056,
"upload_time": "2024-11-17T00:55:25",
"upload_time_iso_8601": "2024-11-17T00:55:25.161685Z",
"url": "https://files.pythonhosted.org/packages/5b/22/51b9d047b827901025023611e77a4ddcb5c413f4bfbb8fb83cac998b588f/chronovoyage-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d304c147d81c7647a6dd26f2258a36547c86550176d2c72a2074d756375638b",
"md5": "3059dc5b654707b5d2a51247895546f7",
"sha256": "4adfdac8deb47f3ed07ffacf2d1818897d412869ec5970d60643821170844b30"
},
"downloads": -1,
"filename": "chronovoyage-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "3059dc5b654707b5d2a51247895546f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 626549,
"upload_time": "2024-11-17T00:55:27",
"upload_time_iso_8601": "2024-11-17T00:55:27.004949Z",
"url": "https://files.pythonhosted.org/packages/5d/30/4c147d81c7647a6dd26f2258a36547c86550176d2c72a2074d756375638b/chronovoyage-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 00:55:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fairy-select",
"github_project": "chronovoyage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chronovoyage"
}
