===============================
proj
===============================
.. image:: https://badge.fury.io/py/proj.png
:target: http://badge.fury.io/py/proj
.. image:: https://travis-ci.org/larsyencken/proj.png?branch=master
:target: https://travis-ci.org/larsyencken/proj
.. image:: https://pypip.in/d/proj/badge.png
:target: https://pypi.python.org/pypi/proj
A command-line folder manager for archiving and restoring a long-term set of projects.
* Free software: BSD license
* Documentation: https://proj.readthedocs.org.
``proj`` assumes the following working setup:
- You have a directory of active projects that you're working on (e.g. ~/Projects)
- You have a directory of inactive projects, your archive (e.g. ~/Archive)
Given this setup, ``proj`` helps you add and remove projects from your archive, and keeps your archive organised in ``<year>/<quarter>`` subfolders, based on when each project was last worked on.
Installation
------------
Install the package with pip:
.. code:: console
pip install proj
Then, tell ``proj`` where your archive directory is, by creating a ``~/.proj.yml`` file
.. code::
archive_dir: _archive
You can enable compression for archives by adding more directives to the YAML file:
.. code::
compression: true
compression_format: bztar
The supported formats are: ``tar``, ``gztar``, ``bztar`` and ``zip``.
Usage
-----
Use proj to get rid of clutter in your main directory of projects by archiving ones that aren't being worked on. Proj will detect when you last made a change and file it accordingly.
.. code:: console
$ ls
cocktails-that-are-blue news-for-llamas old-crusty-project
$ proj archive old-crusty-project
old-crusty-project -> /Users/lars/Archive/2012/q3/old-crusty-project
$ ls
cocktails-that-are-blue news-for-llamas
$ proj list
2012/q3/old-crusty-project
Now we've archived this project, but we can restore it at any time.
.. code:: console
$ proj restore old-crusty-project
/Users/lars/Archive/2012/q3/old-crusty-project -> old-crusty-project
$ ls
cocktails-that-are-blue news-for-llamas old-crusty-project
Features
--------
* ``proj archive``: archive a project to an appropriate directory
* ``proj restore``: restore a project from the archive
* ``proj list``: search the archive for a project
History
-------
0.2.0 (dev)
-----------
* Moved to Python 3.x only support to allow type hinting
* Move to a config file rather than environment variables
* Support compression for archiving and restoring
0.1.0 (2014-01-11)
---------------------
* First release on PyPI.
* Archive, restore and search features.
Raw data
{
"_id": null,
"home_page": "https://github.com/larsyencken/proj",
"name": "proj",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "proj",
"author": "Lars Yencken",
"author_email": "lars@yencken.org",
"download_url": "https://files.pythonhosted.org/packages/a0/2b/70459cdba0d97758ed3ab53641f12d0639e8dd9c3d6bd835977bf5a34c23/proj-0.2.0.tar.gz",
"platform": "",
"description": "===============================\nproj\n===============================\n\n.. image:: https://badge.fury.io/py/proj.png\n :target: http://badge.fury.io/py/proj\n\n.. image:: https://travis-ci.org/larsyencken/proj.png?branch=master\n :target: https://travis-ci.org/larsyencken/proj\n\n.. image:: https://pypip.in/d/proj/badge.png\n :target: https://pypi.python.org/pypi/proj\n\n\nA command-line folder manager for archiving and restoring a long-term set of projects.\n\n* Free software: BSD license\n* Documentation: https://proj.readthedocs.org.\n\n``proj`` assumes the following working setup:\n\n- You have a directory of active projects that you're working on (e.g. ~/Projects)\n- You have a directory of inactive projects, your archive (e.g. ~/Archive)\n\nGiven this setup, ``proj`` helps you add and remove projects from your archive, and keeps your archive organised in ``<year>/<quarter>`` subfolders, based on when each project was last worked on.\n\nInstallation\n------------\n\nInstall the package with pip:\n\n.. code:: console\n\n pip install proj\n\nThen, tell ``proj`` where your archive directory is, by creating a ``~/.proj.yml`` file\n\n.. code::\n\n archive_dir: _archive\n\nYou can enable compression for archives by adding more directives to the YAML file:\n\n.. code::\n\n compression: true\n compression_format: bztar\n\nThe supported formats are: ``tar``, ``gztar``, ``bztar`` and ``zip``.\n\nUsage\n-----\n\nUse proj to get rid of clutter in your main directory of projects by archiving ones that aren't being worked on. Proj will detect when you last made a change and file it accordingly.\n\n.. code:: console\n\n $ ls\n cocktails-that-are-blue news-for-llamas old-crusty-project\n $ proj archive old-crusty-project\n old-crusty-project -> /Users/lars/Archive/2012/q3/old-crusty-project\n $ ls\n cocktails-that-are-blue news-for-llamas\n $ proj list\n 2012/q3/old-crusty-project\n\nNow we've archived this project, but we can restore it at any time.\n\n.. code:: console\n\n $ proj restore old-crusty-project\n /Users/lars/Archive/2012/q3/old-crusty-project -> old-crusty-project\n $ ls\n cocktails-that-are-blue news-for-llamas old-crusty-project\n\nFeatures\n--------\n\n* ``proj archive``: archive a project to an appropriate directory\n* ``proj restore``: restore a project from the archive\n* ``proj list``: search the archive for a project\n\n\n\n\nHistory\n-------\n\n0.2.0 (dev)\n-----------\n\n* Moved to Python 3.x only support to allow type hinting\n* Move to a config file rather than environment variables\n* Support compression for archiving and restoring\n\n0.1.0 (2014-01-11)\n---------------------\n\n* First release on PyPI.\n* Archive, restore and search features.\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "A command-line manager for archiving and retrieving projects.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/larsyencken/proj"
},
"split_keywords": [
"proj"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87d7032c1f29b50e8d970cde7dc25d9231a4b26747be2a0b8b5f3ab20f9d5c42",
"md5": "e8a0d51aff78d381c045e264d061321d",
"sha256": "350b8f46d49e1a5080bb6dff61f8a18c11e81caf2ae0a3ede04e293c9cb891db"
},
"downloads": -1,
"filename": "proj-0.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8a0d51aff78d381c045e264d061321d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 8619,
"upload_time": "2020-05-18T17:07:56",
"upload_time_iso_8601": "2020-05-18T17:07:56.473701Z",
"url": "https://files.pythonhosted.org/packages/87/d7/032c1f29b50e8d970cde7dc25d9231a4b26747be2a0b8b5f3ab20f9d5c42/proj-0.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a02b70459cdba0d97758ed3ab53641f12d0639e8dd9c3d6bd835977bf5a34c23",
"md5": "59c1c6d8d7a1f0cbc064bf699676a972",
"sha256": "acf1e0a6aa3d6e3a7ca56f9a1b25abce80d1e9d6a69d57c89a2bce43133ff65d"
},
"downloads": -1,
"filename": "proj-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "59c1c6d8d7a1f0cbc064bf699676a972",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19620,
"upload_time": "2020-05-18T17:07:58",
"upload_time_iso_8601": "2020-05-18T17:07:58.277708Z",
"url": "https://files.pythonhosted.org/packages/a0/2b/70459cdba0d97758ed3ab53641f12d0639e8dd9c3d6bd835977bf5a34c23/proj-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-05-18 17:07:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "larsyencken",
"github_project": "proj",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [
{
"name": "arrow",
"specs": [
[
"==",
"0.15.6"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"7.1.2"
]
]
},
{
"name": "wheel",
"specs": [
[
"==",
"0.34.2"
]
]
},
{
"name": "PyYAML",
"specs": []
}
],
"test_requirements": [],
"tox": true,
"lcname": "proj"
}
JSON
