https://github.com/abrahamkoloboe27/test-api-hackaton
https://github.com/abrahamkoloboe27/test-api-hackaton
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/abrahamkoloboe27/test-api-hackaton
- Owner: abrahamkoloboe27
- Created: 2024-05-15T14:22:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-06T11:36:08.000Z (12 months ago)
- Last Synced: 2025-01-17T12:35:22.593Z (5 months ago)
- Language: Python
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
E-Tourist API Tester
=====================
Welcome to the E-Tourist API Tester application! This app was created to test the various routes of the E-Tourist API.
Prerequisites
-------------
* Python 3.6 or higher
* Pipenv (recommended) or pip
Installation
------------
1. Clone the repository:
```bash
git clone https://github.com/your-username/e-tourist-api-tester.git
```
2. Navigate to the project directory:
```bash
cd e-tourist-api-tester
```
3. Create a virtual environment (optional but recommended):
```bash
python3 -m venv env
```
4. Activate the virtual environment:
```bash
source env/bin/activate
```
5. Install the dependencies:
```bash
pip install -r requirements.txt
```
Usage
-----
1. Run the app:
```bash
streamlit run app.py
```
2. Select an API route from the sidebar.
3. Follow the instructions for each route. For example, for the `/texte_en_to_texte_fr/` route, enter English text and click the "Traduire" button.
4. Repeat step 3 to test the other routes.
Contribution
------------
Contributions are welcome! If you would like to contribute to this project, please follow these steps:
1. Create a branch for your feature or bug fix.
2. Make your changes.
3. Create a pull request.
License
-------
This project is licensed under the MIT License. See the LICENSE file for details.
Contact
-------
If you have any questions or comments, feel free to contact me at [[email protected]](mailto:[email protected]).