paci 1.5.2

.. |br| raw:: html

<br />

.. figure:: https://raw.github.com/tradebyte/paci/master/.github/images/paci-logo.png
:alt: Your agents are standing by.Your friendly, lightweight and flexible package manager.


--------------

|PyPI version| |GitHub issues| |GitHub license|

paci
====

Your friendly, lightweight and flexible package manager.

It is a package manager which can be used to distribute your own
packages. It is meant to install all packages in your userland.

Please see `Limitations <#limitations>`__

Installation
------------

Via script
~~~~~~~~~~

::

bash <(curl -s https://raw.githubusercontent.com/tradebyte/paci/master/.github/bin/install.sh)

The script takes two parameter ``main_registry`` and
``fallback_registry``. If you want to use them for your setup just
append them accordingly.

Example:

::

bash <(curl -s https://raw.githubusercontent.com/tradebyte/paci/master/.github/bin/install.sh) https://raw.githubusercontent.com/tradebyte/paci/master

(which would define the main registry)

Manually
~~~~~~~~

On Ubuntu 16.04:

.. code:: bash

pip3 install paci

After that you should add ``$HOME/.local/bin`` to your ``$PATH`` in your
``~/.bashrc`` file.

.. code:: bash

export PATH="$PATH:$HOME/.local/bin"

Requirements
------------

- python3
- python3-venv
- rsync

Setup
-----

::

❯ make

Usage
-----

These are the planned commands.

::

❯ paci --help
paci

Usage:
paci install [--no-config] [--no-cleanup] [--reuse] [--overwrite] <package>...
paci update [--no-config] [--no-cleanup] [--reuse] [--overwrite] <package>...
paci search <package>
paci refresh
paci list
paci remove
paci configure [--no-choice] [--silent] [--main-registry=<url>] [--fallback-registry=<url>]
paci generate (repo-index <path> | pkg-index)
paci --help
paci --version

Options:
-h, --help Show this screen.
-v, --version Show version.
-n, --no-config Omits the config.
-c, --no-cleanup Don't cleanup the mess.
-o, --overwrite Overwrite the config.
-r, --reuse Reuse the downloaded files.
(only possible with --no-cleanup)

Examples:
paci install phpstorm

Help:
For help using this tool, please open an issue on the Github repository:
https://github.com/tradebyte/paci

Limitations
-----------

- It currently targets Ubuntu 16.04 only!
- It needs more packages.
- It needs testing.
- It only supports 64bit systems.

Some snippets
-------------

- Run tests: ``$ python setup.py test``
- Activate virtualenv: ``. env/bin/activate``
- Deactivate virtualenv: ``deactivate``
- Run the linter: ``pylint paci``
- New release of this CLI tool (pip):
``$ python setup.py sdist bdist_wheel``

Contributing
------------

See the `CONTRIBUTING <.github/CONTRIBUTING.md>`__ document. |br|
Thank you, `contributors <https://github.com/tradebyte/paci/graphs/contributors>`__!

License
-------

Copyright (c) 2017 by the Tradebyte Software GmbH. |br|
``paci`` is free software, and may be redistributed under the terms specified in the `LICENSE </LICENSE>`__ file.

About
-----

``paci`` is maintained and funded by the Tradebyte Software GmbH. |br|
The names and logos for ``paci`` are trademarks of the Tradebyte Software GmbH.

We love free software!

.. |PyPI version| image:: https://badge.fury.io/py/paci.svg
:target: https://badge.fury.io/py/paci
.. |GitHub issues| image:: https://img.shields.io/github/issues/tradebyte/paci.svg
:target: https://github.com/tradebyte/paci/issues
.. |GitHub license| image:: https://img.shields.io/github/license/tradebyte/paci.svg
:target: https://github.com/tradebyte/paci/blob/master/LICENSE