==============
Python History
==============
.. image:: https://badge.fury.io/py/pyhistory.png
:target: http://badge.fury.io/py/pyhistory
.. image:: https://travis-ci.org/beregond/pyhistory.png?branch=master
:target: https://travis-ci.org/beregond/pyhistory
.. image:: https://img.shields.io/pypi/dm/pyhistory.svg
:target: https://pypi.python.org/pypi/pyhistory
.. image:: https://coveralls.io/repos/beregond/pyhistory/badge.png
:target: https://coveralls.io/r/beregond/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
PyHistory
---------
PyHistory maintains history entries in distributed work environment, which
allows many developers to add/remove history entries between releases without
conflicts.
Installation
------------
.. code-block:: bash
pip install pyhistory
Features
--------
(All commands can start either with `pyhistory` or shortcut - `pyhi`.)
* Add history entry:
.. code-block:: bash
$ pyhi add 'New feature'
$ pyhi add Something
* List history entries:
.. code-block:: bash
$ pyhi list
* New feature
* Something
* Update your history file with entries for given release:
.. code-block:: bash
$ cat HISTORY.rst
my project
==========
0.4.1 (2015-08-04)
++++++++++++++++++
* Added PyHistory to project.
* Improved codebase.
* Other features.
$ 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:
.. code-block:: 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:
.. code-block:: bash
$ pyhi clear
Do you really want to remove all entries? [y/N]: y
Or without prompt:
.. code-block:: bash
$ pyhi clear --yes
Config file
-----------
You can adjust Pyhistory behaviour to your needs by ``setup.cfg`` file. Just
put ``pyhistory`` section in there:
.. code-block:: ini
[pyhistory]
history_dir = some_dir # 'history' by default
history_file = myhistory.rst # 'HISTORY.rst' by default
at_line = 42 # by default history will be injected after first headline
History
-------
2.2.0 (2022-04-04)
++++++++++++++++++
* Added support for python 3.7, 3.8, 3.9 and 3.10.
* Removed support for python 2.7, 3.3, 3.4, 3.5, 3.6 and pypy.
2.1 (2017-09-29)
++++++++++++++++
* Fixed error for empty file.
* Unpinned hard requirements for package.
* Added support for py35 and py36.
2.0 (2015-08-07)
++++++++++++++++
* Added line splitting.
* Moved CLI interface to Click library.
* Added '--yes' flag for clear command.
* Removed 'squash' subcommand.
* Added microseconds to generated files.
* 0 as at-line option in no longer valid.
1.3 (2014-10-17)
++++++++++++++++
* Timestamps are now in miliseconds (again).
* Added load config from file.
1.2.1 (2014-08-06)
++++++++++++++++++
* Improved format of generated hash (no miliseconds now).
1.2 (2014-07-22)
++++++++++++++++
* Added delete command.
1.1 (2014-07-15)
++++++++++++++++
* Added timestamp to generated files, so now entries are properly ordered.
* Pyhistory traverses directory tree to find proper place for history directory.
1.0.3 (2014-06-23)
++++++++++++++++++
* Added squash command (alias to update).
1.0.2 (2014-06-22)
++++++++++++++++++
* Further bug fixing of start detecting.
1.0.1 (2014-06-20)
++++++++++++++++++
* Fixed error raised by `clear` when history dir is absent.
* Fixed `update` - command will now try to find file start.
1.0 (2014-06-20)
++++++++++++++++
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/beregond/pyhistory",
"name": "pyhistory",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pyhistory",
"author": "Szczepan Cie\u015blik",
"author_email": "szczepan.cieslik@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/50/17/11233fa2d952e1b8810940b94b8629af10587d4d18b18430d871e0626eb5/pyhistory-2.2.0.tar.gz",
"platform": null,
"description": "==============\nPython History\n==============\n\n.. image:: https://badge.fury.io/py/pyhistory.png\n :target: http://badge.fury.io/py/pyhistory\n\n.. image:: https://travis-ci.org/beregond/pyhistory.png?branch=master\n :target: https://travis-ci.org/beregond/pyhistory\n\n.. image:: https://img.shields.io/pypi/dm/pyhistory.svg\n :target: https://pypi.python.org/pypi/pyhistory\n\n.. image:: https://coveralls.io/repos/beregond/pyhistory/badge.png\n :target: https://coveralls.io/r/beregond/pyhistory\n\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\nPyHistory\n---------\n\nPyHistory maintains history entries in distributed work environment, which\nallows many developers to add/remove history entries between releases without\nconflicts.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n pip install pyhistory\n\nFeatures\n--------\n\n(All commands can start either with `pyhistory` or shortcut - `pyhi`.)\n\n* Add history entry:\n\n .. code-block:: bash\n\n $ pyhi add 'New feature'\n $ pyhi add Something\n\n* List history entries:\n\n .. code-block:: bash\n\n $ pyhi list\n\n * New feature\n * Something\n\n* Update your history file with entries for given release:\n\n .. code-block:: bash\n\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 $ 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* Delete selected entries:\n\n .. code-block:: bash\n\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* Clear all history:\n\n .. code-block:: bash\n\n $ pyhi clear\n Do you really want to remove all entries? [y/N]: y\n\n Or without prompt:\n\n .. code-block:: bash\n\n $ pyhi clear --yes\n\nConfig file\n-----------\n\nYou can adjust Pyhistory behaviour to your needs by ``setup.cfg`` file. Just\nput ``pyhistory`` section in there:\n\n.. code-block:: ini\n\n [pyhistory]\n history_dir = some_dir # 'history' by default\n history_file = myhistory.rst # 'HISTORY.rst' by default\n at_line = 42 # by default history will be injected after first headline\n\n\n\n\nHistory\n-------\n\n2.2.0 (2022-04-04)\n++++++++++++++++++\n\n* Added support for python 3.7, 3.8, 3.9 and 3.10.\n* Removed support for python 2.7, 3.3, 3.4, 3.5, 3.6 and pypy.\n\n2.1 (2017-09-29)\n++++++++++++++++\n\n* Fixed error for empty file.\n* Unpinned hard requirements for package.\n* Added support for py35 and py36.\n\n2.0 (2015-08-07)\n++++++++++++++++\n\n* Added line splitting.\n* Moved CLI interface to Click library.\n* Added '--yes' flag for clear command.\n* Removed 'squash' subcommand.\n* Added microseconds to generated files.\n* 0 as at-line option in no longer valid.\n\n1.3 (2014-10-17)\n++++++++++++++++\n\n* Timestamps are now in miliseconds (again).\n* Added load config from file.\n\n1.2.1 (2014-08-06)\n++++++++++++++++++\n\n* Improved format of generated hash (no miliseconds now).\n\n1.2 (2014-07-22)\n++++++++++++++++\n\n* Added delete command.\n\n1.1 (2014-07-15)\n++++++++++++++++\n\n* Added timestamp to generated files, so now entries are properly ordered.\n* Pyhistory traverses directory tree to find proper place for history directory.\n\n1.0.3 (2014-06-23)\n++++++++++++++++++\n\n* Added squash command (alias to update).\n\n1.0.2 (2014-06-22)\n++++++++++++++++++\n\n* Further bug fixing of start detecting.\n\n1.0.1 (2014-06-20)\n++++++++++++++++++\n\n* Fixed error raised by `clear` when history dir is absent.\n* Fixed `update` - command will now try to find file start.\n\n1.0 (2014-06-20)\n++++++++++++++++\n\n* First release on PyPI.\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "PyHistory maintains history entries for your project.",
"version": "2.2.0",
"split_keywords": [
"pyhistory"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "97aca1e0b933148e2012b3c12ca28498",
"sha256": "9979a8ab9f45eea04889fcb79151fa81451fe47e219ef96f28e9e2843b9a7650"
},
"downloads": -1,
"filename": "pyhistory-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "97aca1e0b933148e2012b3c12ca28498",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20186,
"upload_time": "2022-04-04T16:31:27",
"upload_time_iso_8601": "2022-04-04T16:31:27.670243Z",
"url": "https://files.pythonhosted.org/packages/50/17/11233fa2d952e1b8810940b94b8629af10587d4d18b18430d871e0626eb5/pyhistory-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-04-04 16:31:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "beregond",
"github_project": "pyhistory",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "attrs",
"specs": [
[
"==",
"21.4.0"
]
]
},
{
"name": "black",
"specs": [
[
"==",
"22.3.0"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.2"
]
]
},
{
"name": "coverage",
"specs": [
[
"==",
"6.3.2"
]
]
},
{
"name": "flake8",
"specs": [
[
"==",
"4.0.1"
]
]
},
{
"name": "iniconfig",
"specs": [
[
"==",
"1.1.1"
]
]
},
{
"name": "isort",
"specs": [
[
"==",
"5.10.1"
]
]
},
{
"name": "mccabe",
"specs": [
[
"==",
"0.6.1"
]
]
},
{
"name": "mypy-extensions",
"specs": [
[
"==",
"0.4.3"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"21.3"
]
]
},
{
"name": "pathspec",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"2.5.1"
]
]
},
{
"name": "pluggy",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "py",
"specs": [
[
"==",
"1.11.0"
]
]
},
{
"name": "pycodestyle",
"specs": [
[
"==",
"2.8.0"
]
]
},
{
"name": "pydash",
"specs": [
[
"==",
"5.1.0"
]
]
},
{
"name": "pyflakes",
"specs": [
[
"==",
"2.4.0"
]
]
},
{
"name": "pyparsing",
"specs": [
[
"==",
"3.0.7"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"7.1.1"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "pytest-cover",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "pytest-coverage",
"specs": [
[
"==",
"0.0"
]
]
},
{
"name": "tomli",
"specs": [
[
"==",
"2.0.1"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.1.1"
]
]
},
{
"name": "verify",
"specs": [
[
"==",
"1.1.1"
]
]
}
],
"lcname": "pyhistory"
}
JSON
