tamayonauta / contact-directory

Application to simulate a contact directory

Contact Directory

Application to simulate a contact directory

Table of contents

1. Requirements
2. Installation
3. Develop
4. Testing
5. Add data to Identification System

Requirements

• Python 3.7
• pip

Installation

1. Clone repository:

   git clone [e-mail]:tamayonauta/contact-directory.git

2. Go to app directory:

   cd app

3. Install requirements:

   pip3 install -r requirements/production.txt

4. Start project:

   python3 main.py

Develop

1. Clone repository:

   git clone [e-mail]:tamayonauta/contact-directory.git

2. Create virtual environment:

   python3 -m venv <my_env_name>

3. Activate virtual environment

   source <my_env_name>/bin/activate

4. Go to app directory:

   cd app

5. Install requirements:

   pip install -r requirements/local.txt

6. Start project:

   python main.py

Testing

1. Go to app directory:

   cd app

2. Run commands:

   python -m unittest

Add data to Identification System

1. Edit file:

   vim app/external_systems/data.py

2. Add data to PERSONAL_DATA list with this structure:

   {
       "id_type": "CC",  # "CC", "CE", "PP"
       "id_number": "1000000",
       "id_exp_date": "2001-01-11",  # "%Y-%m-%d"
       "full_name": "John Doe"
   }

3. Save file

License

This project is licensed under the terms of the MIT license.