AdReg

Advertisement database system
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgements

About The Project

This program creates a database of advertisements that accepts the name of the advertisement, the name of the client, the start and the end dates and the investment per day in BRL. You can create reports on each entry filtered by client and period of time.

Built With

• Peewee
• SQLite
• Schema
• python-tabulate
• pytest

Getting Started

Prerequisites

You will need pip to install the packages. It's strongly recommended that you use a virtual environment. Developed in Python 3.7.3.

Installation

1. Clone the repo

   git clone https://github.com/Aledosim/adreg.git

2. Enter the directory

   cd adreg

3. Install the packages after activate the virtual environment

   pip install -r requirements.txt

Usage

Run the adreg shell script that lives in the root directory. You can't run it out of this location (it's in beta version yet). It will create the database file in root folder as well.

Add entry

At the root directory:

./adreg add -n NAME -c CLIENT -s START -e END -i INVESTMENT

Being that:

• NAME: the name of the advertisement
• CLIENT: the client name
• START: the starting date in the format dd-mm-yyyy
• END: the ending date in the format dd-mm-yyy
• INVESTMENT: the investment per day

The START parameter defaults to the current day, you can omit it.

Visualizing reports

You can visualize the reports with

./adreg report

To filter the results, use the optional parameters

./adreg report -c CLIENT -s START -e END

Being that:

• CLIENT: the client name
• START: starting date in the format dd-mm-yyyy
• END: ending date in the format dd-mm-yyy On this command, END defaults to the current day and his value can be omitted.

Getting help

You can add the -h flag on the commands to see the informations.

Testing

To run the tests execute on the root directory:

pytest

License

Distributed under the GPL3 License. See LICENSE for more information.

Contact

Alexandre do Sim - LinkedIn - [email protected]

Checkout my git projects: https://github.com/Aledosim

Acknowledgements

This application is part of Capgemini Brasil's trainee selection program.

Future tasks

• Implement config module (not fully done)
• Make list and delete functionalities
• Prettier output