معرفی شرکت ها
async-weather-api-0.5.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
This project represents sample of asynchronous weather REST API that is build using quart (flask compatible API) python web microframework based on Asyncio
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | async-weather-api-0.5.0 |
| نام | async-weather-api |
| نسخه کتابخانه | 0.5.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Volodymyr Yahello |
| ایمیل نویسنده | vyahello@gmail.com |
| آدرس صفحه اصلی | https://github.com/vyahello/async-weather-api |
| آدرس اینترنتی | https://pypi.org/project/async-weather-api/ |
| مجوز | - |
[](https://www.python.org/)
[](https://github.com/psf/black)
[](https://github.com/vyahello/async-weather-api/releases)
[](https://travis-ci.org/vyahello/async-weather-api)
[](https://coveralls.io/github/vyahello/async-weather-api?branch=master)
[](https://github.com/vyahello/async-weather-api/network/members)
[](https://github.com/vyahello/async-weather-api/stargazers)
[](https://github.com/vyahello/async-weather-api/issues)
[](https://GitHub.com/vyahello/async-weather-api/graphs/watchers/)
[](https://GitHub.com/vyahello/async-weather-api/graphs/contributors/)
[](https://pypi.python.org/pypi/async-weather-api/)
[](https://pypi.python.org/pypi/async-weather-api/)
[](https://hub.docker.com/repository/docker/vyahello/async-weather-api)
[](LICENSE.md)
# Async weather API
> This project represents sample of asynchronous weather REST API that is build using **quart** (flask compatible API) python web microframework based on Asyncio.
## Tools
- python 3.6 | 3.7 | 3.8
- [asyncio](https://docs.python.org/3/library/asyncio.html)
- [quart](https://pgjones.gitlab.io/quart/)
- code analysis
- [pytest](https://pypi.org/project/pytest/)
- [mypy](http://mypy.readthedocs.io/en/latest)
- [black](https://black.readthedocs.io/en/stable/)
- [pylint](https://www.pylint.org/)
- [flake8](http://flake8.pycqa.org/en/latest/)
- [pydocstyle](http://www.pydocstyle.org/)
## Usage
### PYPI
Please run following script to obtain latest package from PYPI:
```bash
➜ pip install async-weather-api
```
Then please execute instructions below to launch game from your environment:
```python
import weather
weather.run(key="your-secret-key", bind="0.0.0.0:5001", debug=False)
Running on https://0.0.0.0:5001 (CTRL + C to quit)
...
```
> Note `key` stands for API key from https://openweathermap.org
### Docker image
Please run next command to start async weather api via docker:
```bash
docker run -it -p 3000:5001 vyahello/async-weather-api:0.5.0 weather run --bind 0.0.0.0:5001 --mode prod --key <secret-key>
```
### Source code
To be able to run source code please execute command below:
```bash
➜ python -m weather run --bind 0.0.0.0:5001 --mode prod --key your-secret-key
Running on https://0.0.0.0:5001 (CTRL + C to quit)
...
```
### Endpoints
- **/** - home page
```bash
➜ curl -X GET http://0.0.0.0:5001/
➜ curl -X GET http://0.0.0.0:5001/index
```
**Response**: html page
- **/api/weather/{city}/{state}/{country}** - current weather event
```bash
➜ curl -X GET http://0.0.0.0:5001/api/events/London/GB/GreatBritain
```
**Response**: json object
```json
{"city":"London","country":"GreatBritain","name":"Jeff the player","state":"GB"}
```
- **/api/weather/{zip_code}/{country}** - current weather in city
```bash
➜ curl -X GET http://0.0.0.0:5001/api/weather/97002/us
```
**Response**: json object
```json
{"base":"stations","clouds":{"all":90},"cod":200,"coord":{"lat":45.23,"lon":-122.8},
...}
```
- **/api/sun/{zip_code}/{country}** - current sunset/sunrise in city
```bash
➜ curl -X GET http://0.0.0.0:5001/sun/weather/97002/us
```
**Response**: json object
```json
{"astronomical_twilight_begin":"04:03:49 PM","astronomical_twilight_end":"04:29:50 AM",
...}
```
## Development notes
### CI/CD
Project has Travis CI integration using [.travis.yml](.travis.yml) file thus code analysis (`black`, `mypy`, `pydocstyle`, `pylint`, `flake8`) and unittests (`pytest`) will be run automatically
after every made change to the repository.
To be able to run code analysis, please execute command below:
```bash
➜ ./analyse-code.sh
```
Also `test-report.html` will be generated after unittests execution.
Other than that, a fresh versioned package will be delivered on PYPI after new tag is created using [pythonpublish.yml](.github/workflows/pythonpublish.yml) file.
### Release notes
* 0.5.0
* Add official docker image
* 0.4.2
* Add manifest package installer file
* 0.4.1
* Read requirements for PYPI build
* 0.4.0
* Introduce PYPI package
* 0.3.0
* Introduce asynchronous approach
* 0.2.0
* Introduce synchronous approach
* 0.1.0
* Distribute initial project version
### Meta
Author – Volodymyr Yahello
Distributed under the `MIT` license. See [LICENSE](LICENSE.md) for more information.
You can reach out me at:
* [vyahello@gmail.com](vyahello@gmail.com)
* [https://github.com/vyahello](https://github.com/vyahello)
* [https://www.linkedin.com/in/volodymyr-yahello-821746127](https://www.linkedin.com/in/volodymyr-yahello-821746127)
### Contributing
1. clone the repository
2. configure Git for the first time after cloning with your `name` and `email`
3. `pip install -r requirements.txt` to install all project dependencies
3. `pip install -r requirements-dev.txt` to install all development project dependencies
نیازمندی
| مقدار | نام |
|---|---|
| ==0.6.15 | quart |
| ==3.6.2 | aiohttp |
| ==2.0.0 | aiodns |
| ==2.1.5 | cchardet |
| ==42.0.2 | setuptools |
| ==0.33.6 | wheel |
| ==3.1.1 | twine |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6 | Python |
نحوه نصب
نصب پکیج whl async-weather-api-0.5.0:
pip install async-weather-api-0.5.0.whl
نصب پکیج tar.gz async-weather-api-0.5.0:
pip install async-weather-api-0.5.0.tar.gz