mirror of
https://github.com/gryf/slack-backup.git
synced 2025-12-17 11:30:25 +01:00
Added section about config in readme
This commit is contained in:
54
README.rst
54
README.rst
@@ -116,6 +116,60 @@ command.
|
||||
|
||||
See help for the ``slack-backup`` command for complete list of options.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
For convenience, you can place all of needed options into configuration file
|
||||
(aka .ini), which all options (with their defaults) will look like:
|
||||
|
||||
.. code:: ini
|
||||
|
||||
[common]
|
||||
channels =
|
||||
database =
|
||||
quiet = 0
|
||||
verbose = 0
|
||||
|
||||
[generate]
|
||||
output =
|
||||
format = text
|
||||
theme = plain
|
||||
|
||||
[fetch]
|
||||
user =
|
||||
password =
|
||||
team =
|
||||
token =
|
||||
|
||||
Note, that you don't have to put every option. To illustrate ``fetch`` example
|
||||
from above, here is a corresponding config file:
|
||||
|
||||
.. code:: ini
|
||||
|
||||
[common]
|
||||
database = mydatabase.sqlite
|
||||
quiet = 2
|
||||
|
||||
[fetch]
|
||||
user = some@email.address.org
|
||||
password = secret
|
||||
team = myteam
|
||||
token = xxxx-1111111111-222222222222-333333333333-r4nd0ms7uff
|
||||
|
||||
Note, that only ``[common]`` and ``[fetch]`` sections are provided, so it is
|
||||
enough to invoke ``slack-backup`` command as:
|
||||
|
||||
.. code:: shell-session
|
||||
|
||||
(myenv)user@localhost ~/mylogs $ slack-backup fetch
|
||||
|
||||
There are couple of places, where configuration file would be searched for, in
|
||||
particular order:
|
||||
|
||||
* file provided via argument ``-i`` or ``--config``
|
||||
* ``slack-backup.ini`` in current directory
|
||||
* ``$XDG_CONFIG_HOME/slack-backup.ini``, where ``$XDG_CONFIG_HOME`` usually
|
||||
defaults to ``$HOME/.config``
|
||||
|
||||
Details
|
||||
-------
|
||||
|
||||
2
setup.py
2
setup.py
@@ -10,7 +10,7 @@ except ImportError:
|
||||
|
||||
setup(name="slack-backup",
|
||||
packages=["slack_backup"],
|
||||
version="0.3",
|
||||
version="0.4",
|
||||
description="Make copy of slack converstaions",
|
||||
author="Roman Dobosz",
|
||||
author_email="gryf73@gmail.com",
|
||||
|
||||
@@ -53,12 +53,7 @@ class Config(object):
|
||||
|
||||
def load_config(self, args):
|
||||
|
||||
if not args.config:
|
||||
path = os.path.join(os.path.abspath('.'), 'slack-backup.ini')
|
||||
else:
|
||||
path = args.config
|
||||
|
||||
locations = [path,
|
||||
locations = [args.config,
|
||||
'./slack-backup.conf',
|
||||
os.path.expandvars('$XDG_CONFIG_HOME/slack-backup.ini'),
|
||||
os.path.expandvars('$HOME/.config/slack-backup.ini')]
|
||||
|
||||
Reference in New Issue
Block a user