Coimbra Chamber

Table of Contents

• Description
• Installation
• Getting Started
• Python Version
• MySQL Database
• Preferred Way to Run Tests
• Images

Description

Back to Table of Contents

Description will go here.

Installation

Run the following to install:

$ pip install coimbra_chamber

Getting Started

Back to Table of Contents

We must configure our database before running any analysis:

First, we must decide if we want to use an in-memory SQLite database or point to an instance of a MySQL database. Then we need to create a config file in our working directory to reflect our configuration.

Create a copy of the file example-config.ini from the repository and rename it to config.ini. Move the config.ini file that we just created into your working directory and open the file. Change database_type to memory if we chose an in-memory database above. Otherwise, leave the database_type as MySQL and replace the host, user, and password fields with the host, username, and password for MySQL database we choose.

Then, to run an analysis:

>>> import coimbra_chamber as cc
>>> manager = cc.DataManager()
>>> manager.run()

Follow the prompts in the terminal to complete your analysis.

Python Version

Back to Table of Contents

This module is intended to use Python 3.6. and above.

MySQL Database

Back to Table of Contents

NOTE: In order to run the integration tests, a local version of mySQL must be installed and running.

On OSX you can run the following line to start the mySQL service after installing from LINK

$ sudo launchctl load -F /Library/LaunchDaemons/com.oracle.oss.mysql.mysqld.plist

Stopping the mySQL service:

$ sudo launchctl unload -F /Library/LaunchDaemons/com.oracle.oss.mysql.mysqld.plist

Preferred Way to Run Tests

Back to Table of Contents

1. From the repo directory; i.e., coimbra_chamber .. code-block:: bash

$ python -m pytest tests -xv --cov=coimbra_chamber --cov-report html tests

The above line requires both pytest and pytest-cov are installed.

Images

Back to Table of Contents