Browse Source

update information

pull/16/head
R4SAS 6 years ago
parent
commit
03b4fcc2ea
  1. 5
      README.md
  2. 93
      README.rst
  3. 12
      setup.py

5
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 PBinCLI
===== =====
@ -58,4 +61,4 @@ Write a more complete usage documentation.
License License
------- -------
This project is licensed under the MIT license, which can be found in the file 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.

93
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 <https://github.com/PrivateBin/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 - <<EOF
Hello! This is test paste!
EOF
It will send string ``Hello! This is test paste!`` to PrivateBin.
To send file use ``--file`` or ``-f`` with filename. Example:
.. code-block::
$ pbincli send -c "My document" -f info.pdf
To retrieve paste from server, use ``get`` command with paste info.
It must be formated like ``pasteID#passphrase``. Example:
.. code-block::
$ pbincli get 49eeb1326cfa9491#vfeortoVWaYeJlviDdhxQBtj5e0I2kArpynrtu/tnGs=
More info you can find by typing
.. code-block::
$ pbincli [-h] {send, get, delete}
TODO
----
Write a more complete usage documentation.
License
-------
This project is licensed under the MIT license, which can be found in the file
`LICENSE <https://github.com/r4sas/PBinCLI/blob/master/LICENSE>`_ in the root of the project source code.

12
setup.py

@ -1,6 +1,7 @@
#!/usr/bin/env python #!/usr/bin/env python
from setuptools import setup from setuptools import setup
from pbincli.__init__ import __version__ as pbincli_version
with open("README.md") as readme: with open("README.md") as readme:
long_description = readme.read() long_description = readme.read()
@ -10,19 +11,22 @@ with open("requirements.txt") as f:
setup( setup(
name='PBinCLI', name='PBinCLI',
version='0.1', version=pbincli_version,
description='PrivateBin client for command line', description='PrivateBin client for command line',
long_description=long_description, long_description=long_description,
author='R4SAS', author='R4SAS',
author_email='r4sas@i2pmail.org', author_email='r4sas@i2pmail.org',
url='https://github.com/r4sas/PBinCLI', url='https://github.com/r4sas/PBinCLI',
keywords='privatebin', keywords='privatebin cryptography security',
license='MIT', license='MIT',
classifiers=[ classifiers=[
'Development Status :: 4 - Beta', 'Development Status :: 5 - Production/Stable',
'Environment :: Console',
'Intended Audience :: End Users/Desktop'
'License :: OSI Approved :: MIT License', 'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3',
'Environment :: Console', 'Topic :: Security :: Cryptography',
'Topic :: Utilities',
], ],
packages=['pbincli'], packages=['pbincli'],
install_requires=install_requires, install_requires=install_requires,

Loading…
Cancel
Save