| Name | pyhistory JSON |
| Version |
2.3.0
JSON |
| download |
| home_page | None |
| Summary | PyHistory maintains history entries in distributed work environment, which allows many developers to add/remove history entries between releases without conflicts. |
| upload_time | 2025-08-31 12:05:28 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyHistory
[](https://badge.fury.io/py/pyhistory)
[](https://pepy.tech/projects/pyhistory)
App to maintain history file for your project.
* Free software: BSD license
* Source: <https://github.com/beregond/pyhistory>
* PyPI: <https://pypi.python.org/pypi/pyhistory>
* ReadTheDocs: <https://pyhistory.readthedocs.io/en/latest/>
PyHistory maintains history entries in distributed work environment, which
allows many developers to add/remove history entries between releases without
conflicts.
## Installation
```bash
pip install pyhistory
```
## Features
(All commands can start either with `pyhistory` or shortcut - `pyhi`.)
* Add history entry:
```bash
pyhi add 'New feature'
pyhi add Something
```
* List history entries:
```bash
$ pyhi list
* New feature
* Something
```
* Update your history file with entries for given release:
```bash
$ cat HISTORY.rst
my project
==========
0.4.1 (2015-08-04)
++++++++++++++++++
* Added PyHistory to project.
* Improved codebase.
* Other features.
```
```bash
$ pyhi update 0.4.2
$ cat HISTORY.rst
my project
==========
0.4.2 (2015-08-05)
++++++++++++++++++
* Bug fixes
* Change in API
* Removed old features
0.4.1 (2015-08-04)
++++++++++++++++++
* Added PyHistory to project
* Improved codebase
* Other features
```
* Delete selected entries:
```bash
$ pyhi delete
1. New feature
2. Something
3. Another one
4. Wrong one
(Delete by choosing entries numbers.)
$ pyhi delete 2 4
$ pyhi list
* New feature
* Another one
```
* Clear all history:
```bash
$ pyhi clear
Do you really want to remove all entries? [y/N]: y
```
Or without prompt:
```bash
pyhi clear --yes
```
## Config file
(``setup.cfg`` has precedence over ``pyproject.toml`` for backward compatibility!)
You can adjust Pyhistory behaviour to your needs by adding config to ``pyproject.toml`` file:
```toml
[tool.pyhistory]
history_dir = "some_dir" # 'history' by default
history_file = "myhistory.md" # 'HISTORY.rst' by default
at_line = 42 # by default history will be injected after first headline
```
You can also add config to ``setup.cfg`` file. Just put ``pyhistory`` section in there:
```ini
[pyhistory]
history_dir = some_dir
history_file = myhistory.rst
at_line = 42
```
## Differences in formatting
If you are using markdown format you must note that:
* Lines are not wrapped, setting for line length is ignored
* There is extra config for markdown formatting - `md_header_level` (default is 2) and it sets amount of `#` in headline for version
Raw data
{
"_id": null,
"home_page": null,
"name": "pyhistory",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Szczepan Cie\u015blik <szczepan.cieslik@gmail.com>",
"download_url": null,
"platform": null,
"description": "# PyHistory\n\n[](https://badge.fury.io/py/pyhistory)\n[](https://pepy.tech/projects/pyhistory)\n\nApp to maintain history file for your project.\n\n* Free software: BSD license\n* Source: <https://github.com/beregond/pyhistory>\n* PyPI: <https://pypi.python.org/pypi/pyhistory>\n* ReadTheDocs: <https://pyhistory.readthedocs.io/en/latest/>\n\nPyHistory maintains history entries in distributed work environment, which\nallows many developers to add/remove history entries between releases without\nconflicts.\n\n## Installation\n\n```bash\npip install pyhistory\n```\n\n## Features\n\n(All commands can start either with `pyhistory` or shortcut - `pyhi`.)\n\n* Add history entry:\n\n ```bash\n pyhi add 'New feature'\n pyhi add Something\n ```\n\n* List history entries:\n\n ```bash\n $ pyhi list\n\n * New feature\n * Something\n ```\n\n* Update your history file with entries for given release:\n\n ```bash\n $ cat HISTORY.rst\n my project\n ==========\n\n 0.4.1 (2015-08-04)\n ++++++++++++++++++\n\n * Added PyHistory to project.\n * Improved codebase.\n * Other features.\n ```\n\n ```bash\n $ pyhi update 0.4.2\n $ cat HISTORY.rst\n my project\n ==========\n\n 0.4.2 (2015-08-05)\n ++++++++++++++++++\n\n * Bug fixes\n * Change in API\n * Removed old features\n\n 0.4.1 (2015-08-04)\n ++++++++++++++++++\n\n * Added PyHistory to project\n * Improved codebase\n * Other features\n ```\n\n* Delete selected entries:\n\n ```bash\n $ pyhi delete\n\n 1. New feature\n 2. Something\n 3. Another one\n 4. Wrong one\n\n (Delete by choosing entries numbers.)\n\n $ pyhi delete 2 4\n $ pyhi list\n\n * New feature\n * Another one\n ```\n\n* Clear all history:\n\n ```bash\n $ pyhi clear\n Do you really want to remove all entries? [y/N]: y\n ```\n\n Or without prompt:\n\n ```bash\n pyhi clear --yes\n ```\n\n## Config file\n\n(``setup.cfg`` has precedence over ``pyproject.toml`` for backward compatibility!)\n\nYou can adjust Pyhistory behaviour to your needs by adding config to ``pyproject.toml`` file:\n\n```toml\n [tool.pyhistory]\n history_dir = \"some_dir\" # 'history' by default\n history_file = \"myhistory.md\" # 'HISTORY.rst' by default\n at_line = 42 # by default history will be injected after first headline\n```\n\nYou can also add config to ``setup.cfg`` file. Just put ``pyhistory`` section in there:\n\n```ini\n [pyhistory]\n history_dir = some_dir\n history_file = myhistory.rst\n at_line = 42\n```\n\n## Differences in formatting\n\nIf you are using markdown format you must note that:\n\n* Lines are not wrapped, setting for line length is ignored\n* There is extra config for markdown formatting - `md_header_level` (default is 2) and it sets amount of `#` in headline for version\n",
"bugtrack_url": null,
"license": null,
"summary": "PyHistory maintains history entries in distributed work environment, which allows many developers to add/remove history entries between releases without conflicts.",
"version": "2.3.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3a9030c333159f63f9b98e6fb1f4d47cd151e8aa8ea6a941390f420740c79586",
"md5": "20583579a0df105767d00b1bc6531bf1",
"sha256": "edaea79f2cb1973e282212d84d06e8f0e93778cde526e86885afe6330b7ef54a"
},
"downloads": -1,
"filename": "pyhistory-2.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "20583579a0df105767d00b1bc6531bf1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 8216,
"upload_time": "2025-08-31T12:05:28",
"upload_time_iso_8601": "2025-08-31T12:05:28.190240Z",
"url": "https://files.pythonhosted.org/packages/3a/90/30c333159f63f9b98e6fb1f4d47cd151e8aa8ea6a941390f420740c79586/pyhistory-2.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-31 12:05:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyhistory"
}
