autopip
===========
Easily install apps from PyPI and automatically keep them updated.
`autopip` automates the creation of a virtual environment using `venv <https://docs.python.org/3/library/venv.html>`_,
installs any Python package with scripts (i.e. app) from PyPI using `pip <https://pypi.org/project/pip/>`_, and
atomically creates symlinks for installed scripts in `/usr/local/bin` so you can easily use them. Each app version is
installed cleanly into its own virtual environment. Optionally, it can set up crontab entries to update apps
automatically (may require admin permission on macOS).
Before starting, make sure your Python installation meets all the requirements -- while `autopip` can install Python
apps that run on any Python version, it requires Python 3.6+ to run::
curl -s https://raw.githubusercontent.com/maxzheng/autopip/master/etc/check-python.py | python3
To install `autopip` to `/usr/local/bin`::
sudo pip3 install autopip
No need to worry about tainting system Python install as `autopip` has no install dependencies and never will.
Alternatively, you can install it in a virtual environment -- the last one that you will ever create manually for
installing Python apps::
python3 -m venv ~/.virtualenvs/autopip
source ~/.virtualenvs/autopip/bin/activate
pip3 install autopip
Optionally, create installation directories and chown to your user so that ``autopip`` can create symlinks in
`/usr/local/bin`::
sudo mkdir /usr/local/opt /usr/local/var
sudo chown -R $(whoami) /usr/local/*
Now, you can easily install any apps from PyPI:
.. code-block:: console
$ autopip install workspace-tools
Installing workspace-tools to /usr/local/opt/apps/workspace-tools/3.2.2
Updating symlinks in /usr/local/bin
+ wst
Optionally use the ``--update`` option to update it daily via cron (may require admin permission on macOS):
.. code-block:: console
$ autopip install workspace-tools --update daily
workspace-tools is up-to-date
Adding to crontab (may require admin permission)
Daily auto-update enabled via cron service
Scripts are in /usr/local/bin: wst
Install paths are selected based on your user's permission to write to `/opt` or `/usr/local/opt`. If you do not have
permission for either, then ``autopip`` will install apps to your user home at `~/.apps` with script symlinks in `~/bin`
therefore you will need to add `~/bin` to your PATH env var to easily run scripts from installed apps. To install
script symlinks to `/usr/local/bin`, either chown/chmod dirs in `/usr/local/*` to be writeable by your user as suggested
above or run ``autopip`` using ``sudo`` (i.e. as root). To see why a particular path is selected, append ``--debug``
after ``autopip`` when running it.
To save typing a few letters, you can also use the ``app`` alias -- short for **a**\ uto\ **p**\ i\ **p**.
.. code-block:: console
$ app install ansible-hostmanager
Installing ansible-hostmanager to /usr/local/opt/apps/ansible-hostmanager/0.2.3
Updating script symlinks in /usr/local/bin
+ ah
To install an app for a specific Python version, use the ``--python`` option:
.. code-block:: console
$ app install ducktape --python 3.7
Installing ducktape to /usr/local/opt/apps/ducktape/0.7.3
Updating script symlinks in /usr/local/bin
+ ducktape
To show currently installed apps and their scripts:
.. code-block:: console
$ app list --scripts
ansible-hostmanager 0.2.3 /usr/local/opt/apps/ansible-hostmanager/0.2.3
/usr/local/bin/ah
ducktape 0.7.3 /usr/local/opt/apps/ducktape/0.7.3
/usr/local/bin/ducktape
workspace-tools 3.2.2 /usr/local/opt/apps/workspace-tools/3.2.2 [updates daily]
/usr/local/bin/wst
To manually update all apps:
.. code-block:: console
$ app update
ansible-hostmanager is up-to-date
ducktape is up-to-date
workspace-tools is up-to-date
To uninstall::
app uninstall ducktape
If you need to use a private PyPI index, just configure `index-url` in `pip.conf
<https://pip.pypa.io/en/stable/user_guide/#configuration>`_ as `autopip` uses `pip` to install apps.
To control versioning and uniform installations across multiple hosts/users, you can also define an `autopip`
installation group using entry points. See example in `developer-tools <https://pypi.org/project/developer-tools/>`_
package.
FAQ
===
1. Cron jobs have a random minute set during install and runs hourly for all intervals.
2. Up to two versions of an app is kept at a time.
Links & Contact Info
====================
| PyPI Package: https://pypi.python.org/pypi/autopip
| GitHub Source: https://github.com/maxzheng/autopip
| Report Issues/Bugs: https://github.com/maxzheng/autopip/issues
|
| Follow: https://twitter.com/MaxZhengX
| Connect: https://www.linkedin.com/in/maxzheng
| Contact: maxzheng.os @t gmail.com
Raw data
{
"_id": null,
"home_page": "https://github.com/maxzheng/autopip",
"name": "autopip",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "automatically pip virtualenv auto-update apps",
"author": "Max Zheng",
"author_email": "maxzheng.os@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/92/f3/ec7d65a13afb7c3be06475288a4a491e75b767541408978a5666d006b90e/autopip-1.7.9.tar.gz",
"platform": null,
"description": "autopip\n===========\n\nEasily install apps from PyPI and automatically keep them updated.\n\n`autopip` automates the creation of a virtual environment using `venv <https://docs.python.org/3/library/venv.html>`_,\ninstalls any Python package with scripts (i.e. app) from PyPI using `pip <https://pypi.org/project/pip/>`_, and\natomically creates symlinks for installed scripts in `/usr/local/bin` so you can easily use them. Each app version is\ninstalled cleanly into its own virtual environment. Optionally, it can set up crontab entries to update apps\nautomatically (may require admin permission on macOS).\n\nBefore starting, make sure your Python installation meets all the requirements -- while `autopip` can install Python\napps that run on any Python version, it requires Python 3.6+ to run::\n\n curl -s https://raw.githubusercontent.com/maxzheng/autopip/master/etc/check-python.py | python3\n\nTo install `autopip` to `/usr/local/bin`::\n\n sudo pip3 install autopip\n\nNo need to worry about tainting system Python install as `autopip` has no install dependencies and never will.\n\nAlternatively, you can install it in a virtual environment -- the last one that you will ever create manually for\ninstalling Python apps::\n\n python3 -m venv ~/.virtualenvs/autopip\n source ~/.virtualenvs/autopip/bin/activate\n pip3 install autopip\n\nOptionally, create installation directories and chown to your user so that ``autopip`` can create symlinks in\n`/usr/local/bin`::\n\n sudo mkdir /usr/local/opt /usr/local/var\n sudo chown -R $(whoami) /usr/local/*\n\nNow, you can easily install any apps from PyPI:\n\n.. code-block:: console\n\n $ autopip install workspace-tools\n Installing workspace-tools to /usr/local/opt/apps/workspace-tools/3.2.2\n Updating symlinks in /usr/local/bin\n + wst\n\nOptionally use the ``--update`` option to update it daily via cron (may require admin permission on macOS):\n\n.. code-block:: console\n\n $ autopip install workspace-tools --update daily\n workspace-tools is up-to-date\n Adding to crontab (may require admin permission)\n Daily auto-update enabled via cron service\n Scripts are in /usr/local/bin: wst\n\nInstall paths are selected based on your user's permission to write to `/opt` or `/usr/local/opt`. If you do not have\npermission for either, then ``autopip`` will install apps to your user home at `~/.apps` with script symlinks in `~/bin`\ntherefore you will need to add `~/bin` to your PATH env var to easily run scripts from installed apps. To install\nscript symlinks to `/usr/local/bin`, either chown/chmod dirs in `/usr/local/*` to be writeable by your user as suggested\nabove or run ``autopip`` using ``sudo`` (i.e. as root). To see why a particular path is selected, append ``--debug``\nafter ``autopip`` when running it.\n\nTo save typing a few letters, you can also use the ``app`` alias -- short for **a**\\ uto\\ **p**\\ i\\ **p**.\n\n.. code-block:: console\n\n $ app install ansible-hostmanager\n Installing ansible-hostmanager to /usr/local/opt/apps/ansible-hostmanager/0.2.3\n Updating script symlinks in /usr/local/bin\n + ah\n\nTo install an app for a specific Python version, use the ``--python`` option:\n\n.. code-block:: console\n\n $ app install ducktape --python 3.7\n Installing ducktape to /usr/local/opt/apps/ducktape/0.7.3\n Updating script symlinks in /usr/local/bin\n + ducktape\n\nTo show currently installed apps and their scripts:\n\n.. code-block:: console\n\n $ app list --scripts\n ansible-hostmanager 0.2.3 /usr/local/opt/apps/ansible-hostmanager/0.2.3\n /usr/local/bin/ah\n ducktape 0.7.3 /usr/local/opt/apps/ducktape/0.7.3\n /usr/local/bin/ducktape\n workspace-tools 3.2.2 /usr/local/opt/apps/workspace-tools/3.2.2 [updates daily]\n /usr/local/bin/wst\n\nTo manually update all apps:\n\n.. code-block:: console\n\n $ app update\n ansible-hostmanager is up-to-date\n ducktape is up-to-date\n workspace-tools is up-to-date\n\nTo uninstall::\n\n app uninstall ducktape\n\nIf you need to use a private PyPI index, just configure `index-url` in `pip.conf\n<https://pip.pypa.io/en/stable/user_guide/#configuration>`_ as `autopip` uses `pip` to install apps.\n\nTo control versioning and uniform installations across multiple hosts/users, you can also define an `autopip`\ninstallation group using entry points. See example in `developer-tools <https://pypi.org/project/developer-tools/>`_\npackage.\n\nFAQ\n===\n\n1. Cron jobs have a random minute set during install and runs hourly for all intervals.\n2. Up to two versions of an app is kept at a time.\n\nLinks & Contact Info\n====================\n\n| PyPI Package: https://pypi.python.org/pypi/autopip\n| GitHub Source: https://github.com/maxzheng/autopip\n| Report Issues/Bugs: https://github.com/maxzheng/autopip/issues\n|\n| Follow: https://twitter.com/MaxZhengX\n| Connect: https://www.linkedin.com/in/maxzheng\n| Contact: maxzheng.os @t gmail.com\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Easily install apps from PyPI and automatically keep them updated",
"version": "1.7.9",
"project_urls": {
"Homepage": "https://github.com/maxzheng/autopip"
},
"split_keywords": [
"automatically",
"pip",
"virtualenv",
"auto-update",
"apps"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30560e55e0d822c957f0313067dcd62753aad3196e8e6ee85ed1fc5d2837cc32",
"md5": "a2143269a21e9cbd80283374ba1d38fd",
"sha256": "3c210112cae76aea09e111dfa1bef9308c87a7c2cce1e68cc3b61efe30b314c5"
},
"downloads": -1,
"filename": "autopip-1.7.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2143269a21e9cbd80283374ba1d38fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17344,
"upload_time": "2023-11-02T01:51:09",
"upload_time_iso_8601": "2023-11-02T01:51:09.346274Z",
"url": "https://files.pythonhosted.org/packages/30/56/0e55e0d822c957f0313067dcd62753aad3196e8e6ee85ed1fc5d2837cc32/autopip-1.7.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92f3ec7d65a13afb7c3be06475288a4a491e75b767541408978a5666d006b90e",
"md5": "a5ba0f71fc0df5951228404f54a8b9e8",
"sha256": "c1007b15d66fb01c59f3f6f96d0585116b92fb66c40e0a6622d4389d0a9168bf"
},
"downloads": -1,
"filename": "autopip-1.7.9.tar.gz",
"has_sig": false,
"md5_digest": "a5ba0f71fc0df5951228404f54a8b9e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 28764,
"upload_time": "2023-11-02T01:51:11",
"upload_time_iso_8601": "2023-11-02T01:51:11.963501Z",
"url": "https://files.pythonhosted.org/packages/92/f3/ec7d65a13afb7c3be06475288a4a491e75b767541408978a5666d006b90e/autopip-1.7.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-02 01:51:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxzheng",
"github_project": "autopip",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "autopip"
}
JSON
