diff --git a/README.md b/README.md index 8b6144f..efc82f7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +[![GitHub license](https://img.shields.io/github/license/r4sas/PBinCLI.svg)](https://github.com/r4sas/PBinCLI/blob/master/LICENSE) +[![GitHub release](https://img.shields.io/github/release/r4sas/PBinCLI.svg)](https://github.com/r4sas/PBinCLI/releases/) + PBinCLI ===== @@ -58,4 +61,4 @@ Write a more complete usage documentation. License ------- This project is licensed under the MIT license, which can be found in the file -[LICENSE](LICENSE) in the root of the project source code. +[LICENSE](https://github.com/r4sas/PBinCLI/blob/master/LICENSE) in the root of the project source code. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..95cf27c --- /dev/null +++ b/README.rst @@ -0,0 +1,93 @@ + + +.. image:: https://img.shields.io/github/license/r4sas/PBinCLI.svg + :target: https://github.com/r4sas/PBinCLI/blob/master/LICENSE + :alt: GitHub license + + +.. image:: https://img.shields.io/github/release/r4sas/PBinCLI.svg + :target: https://github.com/r4sas/PBinCLI/releases/ + :alt: GitHub release + + +PBinCLI +======= + +`PrivateBin `_ CLI +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Installing +---------- + +.. code-block:: bash + + $ virtualenv --python=python3 venv + $ . venv/bin/activate + $ pip install pbincli + +Usage +----- + +By default pbincli configured to use https://paste.i2pd.xyz/ for sending and receiving pastes. No proxy used by default. + +You can create config file with variables ``server`` and ``proxy`` in ``~/.config/pbincli/pbincli.conf`` to use different settings. + +Example contents: + +.. code-block:: + + server=https://paste.i2pd.xyz/ + proxy=http://127.0.0.1:3128 + +Run inside ``venv`` command: + +.. code-block:: + + $ pbincli send --text "Hello!" + + +Or use stdin input to read text for paste: + +.. code-block:: + + $ pbincli send - <`_ in the root of the project source code. diff --git a/setup.py b/setup.py index 31667cf..ba18338 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,7 @@ #!/usr/bin/env python from setuptools import setup +from pbincli.__init__ import __version__ as pbincli_version with open("README.md") as readme: long_description = readme.read() @@ -10,19 +11,22 @@ with open("requirements.txt") as f: setup( name='PBinCLI', - version='0.1', + version=pbincli_version, description='PrivateBin client for command line', long_description=long_description, author='R4SAS', author_email='r4sas@i2pmail.org', url='https://github.com/r4sas/PBinCLI', - keywords='privatebin', + keywords='privatebin cryptography security', license='MIT', classifiers=[ - 'Development Status :: 4 - Beta', + 'Development Status :: 5 - Production/Stable', + 'Environment :: Console', + 'Intended Audience :: End Users/Desktop' 'License :: OSI Approved :: MIT License', 'Programming Language :: Python :: 3', - 'Environment :: Console', + 'Topic :: Security :: Cryptography', + 'Topic :: Utilities', ], packages=['pbincli'], install_requires=install_requires,