https://github.com/halit/doorman

Keeps your secret things
https://github.com/halit/doorman

Last synced: 4 months ago
JSON representation

Keeps your secret things

• Host: GitHub
• URL: https://github.com/halit/doorman
• Owner: halit
• License: mit
• Created: 2013-09-15T20:23:49.000Z (almost 11 years ago)
• Default Branch: develop
• Last Pushed: 2018-03-05T00:43:09.000Z (over 6 years ago)
• Last Synced: 2024-03-05T16:14:34.168Z (4 months ago)
• Language: Python
• Homepage: https://pypi.python.org/pypi/doorman
• Size: 351 KB
• Stars: 84
• Watchers: 10
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Lists

• awesome-stars - halit/doorman - `★84` Keeps your secret things (Python)
• awesome-stars - doorman - Keeps your secret things (Python)

README

        
Doorman

=======

.. image:: https://pypip.in/v/doorman/badge.png

   :target: https://pypi.python.org/pypi/doorman

.. image:: https://pypip.in/d/doorman/badge.png

   :target: https://crate.io/packages/doorman/

.. image:: https://api.travis-ci.org/halitalptekin/doorman.png

    :target: https://travis-ci.org/halitalptekin/doorman

.. image:: https://pypip.in/license/doorman/badge.png

    :target: https://pypi.python.org/pypi/doorman/   

Doorman keeps your secret things but main purpose of this tool, the convenience of the people working on the same file does not store passwords.

Install

-------

.. code-block:: python

    pip install doorman

    

Usage

-----

Firstly, you should create a config file(~/.config/doorman/doorman.yml) or put in text like below lines:

.. code-block::

    

    # social accounts

    /home/user/twitter.rb:

     twitter_password: bHc0yz

     private_key: 1VpzKbLDTqC1vXb

    /home/user/pythoncodes/githubapi.py:

     github_password: wKJ4cV

    # secret text

    /etc/secret.conf:

     my_secret: really secret thing

    # secret function

    ../settings/my_settings.py:

     my_func: [i for i in others if i < 3]

Hide all secret things;

.. code-block:: 

    doorman -s

.. code-block:: 

    # Doorman defaults to -s when no argument is given

    doorman

    

.. code-block::     

    ... my twitter password is {{ twitter_password }} ...

    ... i keep {{ my_secret }} from other ...

Un-hide all secret things;

.. code-block:: 

    doorman -u

    

.. code-block::     

    ... my twitter password is bHc0yz ...

    ... i keep really secret thing from other ...

Help for usage;

.. code-block::

    doorman -h

.. code-block::

    usage: doorman [-h] [-s | -u] [-v] [-c CONFIG_FILE]

    Doorman keeps your secret things

    optional arguments:

      -h, --help            show this help message and exit

      -u, --unsecret        Open all secret things

      -s, --secret          Hide all secret things

      -v, --verbose         Show all messages

      -c CONFIG_FILE, --config CONFIG_FILE

                            Config file

TODO

----

File open and replace: need to completely re-write