Python CRUD API

這是一個Python API 練習

About The Project

這個專案是Python CRUD API 練習

(back to top)

Built With

• Python
• Flask
• Docker
• Pytest

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• docker

  download docker

• pipenv

  pip install pipenv
  pipenv install
  pipenv shell
  exit

Installation

1. Get a free API Key at https://github.com/wadeio/Python-Crud-api
2. Clone the repo

   git clone https://github.com/wadeio/Python-Crud-api.git

(back to top)

Usage

1.打包docker file

docker build -t my-python-app .

2.運行docker image,啟動 API 服務

docker run -it --rm -p 5000:5000 --name my-running-app my-python-app

3.執行單元測試

open terminal
pipenv shell
py.test tests/

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

wadeio - [email protected]

Project Link: https://github.com/wadeio/Python-Crud-api

(back to top)

Acknowledgments

• Best-README-Template

(back to top)