Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
mrouhi13 committed Feb 12, 2019
1 parent bcea2e1 commit 2f1111c
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[![Documentation Status](https://readthedocs.org/projects/djecrety/badge/?version=latest)](https://djecrety.readthedocs.io/en/latest/?badge=latest)

=====
Djecrety
=====

Djecrety is a simple Django app to work with "settings.py" file such as import/export sensitive values, generate a new secret key, add new parameters and update the existing. It also has a web-based tool for generating Django secret key.
Django package implementation of Djecrety web tool. Djecrety package provides a command to generate a new secret key for your project and save it to ``settings.py`` file.

Detailed documentation is in the "docs" directory.
For more details `readthdocs <http://djecrety.readthedocs.io/>`_.

Getting started
===============
Expand Down Expand Up @@ -43,9 +45,9 @@ Configure ``INSTALLED_APPS``:
.. code-block:: python
INSTALLED_APPS = (
(...),
...
'djecrety',
(...),
...
)
Usage
Expand All @@ -54,33 +56,33 @@ Usage
This is really simple, there is only one command with 3 optional arguments.
Let's go!

`djecrety` command with no argument, generate and display a new secret key:
``djecrety`` command with no argument, generate and display a new secret key:

.. code-block:: text
$ ./manage.py dejcrety
With `-s` argument, save the generated secret key to `settings.py` file:
With ``-s`` argument, save the generated secret key to ``settings.py`` file:

.. code-block:: text
$ ./manage.py dejcrety -s
With `-p` argument, display the generated secret key when saving on file:
With ``-p`` argument, display the generated secret key when saving on file:

.. note::

`-p` argument work when saving the secret key to file.
``-p`` argument work when saving the secret key to file.

.. code-block:: text
$ ./manage.py dejcrety -sp
With `-d` argument, specify settings directory name:
With ``-d`` argument, specify settings directory name:

.. note::

By default, we try to detect your project directory and `settings.py` file location, if `settings.py` file not in default location you can specify the directory.
By default, we try to detect your project directory and ``settings.py`` file location, if ``settings.py`` file not in default location you can specify the directory.

.. code-block:: text
Expand Down

0 comments on commit 2f1111c

Please sign in to comment.