Skip to content

spiridonovfed/readme_gen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 

Repository files navigation


Random People Data Project

Randomly generized people data to use as a mock data

Report Bug · Request Feature


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Contact

About The Project

Product Name Screen Shot

This project is built as a final part of Python Basics Training conducted by EPAM. It renders a random people data table using Randomuser.me API. By default quantity of entries is set to 1000, but it can be changed. User can create new entry manually, edit or delete existing exntries.

Built With

Getting Started

Installation

  1. Clone the repo
    git clone https://github.com/spiridonovfed/EPAM_Training_Final_Task
  2. Install required packages
    pip install -r requirements.txt
  3. Change config.py (/persons_table/config.py) if neccessary.
  4. Run flask server
    flask run

Usage

Use empty field and "Change Number" button at the top of a homepage to change quantity of entries in the table. The exceptable range is 1-5000. Upper limit is dictated by Randomuser.me API restrictions. If number inputted is greater than current number of entries, it will add lacking number of entries (i.e. current entries will not be rewritten). All the data is essentally a mock and have nothing to do with real people.

Use "Create an entry" button to create an entry manulally. It will become the last entry in the table after creation.

The last column contains links to perosnal pages. From there, you can delete the entry or go to an editing page. Go to http://homepage/random to get random person personal page.

Dockerfile and docker-compose.yml files are also added. Make sure to review and redact environmental variables there before dockerizing.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Your Name - @spiridonovfed - spiridonovfed@yandex.ru

Project Link: https://github.com/spiridonovfed/EPAM_Training_Final_Task

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published