Skip to content

gustavomagalhaess/python-curriculum-api

Repository files navigation

Project logo

Curriculum Vitae API

GitHub Watchers GitHub Issues GitHub Pull Requests GitHub Stars GitHub Forks


This is a simple Flask API that provides professional career information.

📝 Table of Contents

🧐 About

The purpose of this project is provide a Curriculum Vitae API with a professional career information.

🗁 File System Tree

├── database/            # Database files 
├── docs/                # Documentation files 
├── models/              # Model files 
├── resources/           # Resource files 
├── app.py
├── blacklist.py
├── curriculum-vitae.png
├── .gitignore
├── requirements.txt
└── README.md

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

If you intend to use docker you can just follow the steps below:

# Insite the project folder
$ docker build -t my-python-app .

$ docker run -it --rm --name my-running-app my-python-app

# Inside the container
$ cd database
~/database $ python create_database_exemple.py
~/database $ python insert_data_exemple.py

But if you intend to use python environment you must follow the steps below:

# Insite the project folder
$ python -m venv venv/

$ source venv/bin/activate

$ pip install requirements.txt

$ cd database
~/database $ python create_database_exemple.py
~/database $ python insert_data_exemple.py

$ python app.py # Starts your app

🎈 Usage

Insite the projetc you can find a postman config file with all the requests allowed (~/docs/postman_collection.json)

⛏️ Built Using

✍️ Authors

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages