Metadata-Version: 2.1
Name: damster
Version: 0.2.0
Summary: Reports and metrics for Atlassian Tools
Home-page: UNKNOWN
Author: Xabier Davila
Author-email: davila.xabier@gmail.com
License: Apache License 2.0
Download-URL: https://github.com/cattz/damster
Platform: Platform Independent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Provides-Extra: dev
Requires-Dist: configparser
Requires-Dist: arrow
Requires-Dist: click
Requires-Dist: atlassian-python-api
Requires-Dist: arrow
Requires-Dist: influxdb
Requires-Dist: schedule
Requires-Dist: jinja2
Requires-Dist: psycopg2
Requires-Dist: sshtunnel
Requires-Dist: six
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-pep8; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: tox; extra == 'dev'


# Damster

Scripts to collect metrics and reports from Atlassian tools.
This is a WIP, starting with some reports on Bamboo deployments


    _*Damster*	Builder of dams for logging purposes_


## Database configuration

In order to use any of the queries that access directly to the database, you will need to provide a database
configuration section.

### Direct connection

Use this settings if you can connect directly to the DB port

    [Confluence DB]
    dbname=confluence
    dbuser=confluence
    password=password1
    host=dbhost.example.com
    port=5432


### Use SSH tunnel

Use this configuration when you can not access the DB directly. For example, if your DB is an RDS instance in AWS:


    ----------------------------------------------------------------------

                              |
    -------------+            |    +---------+              +--------+
        LOCAL    |            |    |  APP    |              |  RDS   |
        CLIENT   | <== SSH ======> | SERVER  | <== Sec  ==> | SERVER |
    -------------+            |    +---------+    Group     +--------+
                              |
                          AWS (only access to port 22 on app.server)

    ----------------------------------------------------------------------

Example configuration for the above case:

    [Confluence DB]
    dbname=confluence
    dbuser=confluence
    password=password1
    ssh_gateway=app.server
    host=rds.server
    port=5432

Additionally, you may also need an SSH section, if the defaults do not work for your case:

    [SSH]
    ; All below values are optional. Examples are the default values
    ;ssh_username: current_user
    ;ssh_private_key: ~/.ssh/id_rsa
    ;port: 22
    ;local_bind_port: 6543

