Table of Contents
About The Project
Simple high-level api for all features of hebrew calendar.
Explore the swagger ยป
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Installation
Docker
- Run
docker run -p 8000:8000 benyomin/zmanim-api:latest - Open http://localhost:8000 in your browser to explore the swagger.
Python
- Clone/fork the repo
- Use poetry for build environment and install dependencies:
poetry install - Go to project folder:
cd %repo_location%/zmanim_api - Run
python main.py - Open http://localhost:8000 in your browser to explore the swagger
Tests
Run tests: pytest test/
Run with coverage: coverage run -m pytest -v test/ or coverage xml
Usage
Request:
GET http://localhost:8000/shabbat?cl_offset=18&lat=32.09&lng=34.86
Response:
{
"candle_lighting": "2020-10-09T17:56:00+03:00",
"havdala": "2020-10-10T18:50:00+03:00",
"settings": {
"date": "2020-10-05",
"cl_offset": 18,
"havdala_opinion": "tzeis_8_5_degrees",
"coordinates": [32.09, 34.86],
"elevation": 0
},
"torah_part": "shemini_atzeres",
"late_cl_warning": false
}For more examples, please refer to the Swagger docs
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Contact
Project Link: https://github.com/benyaming/zmanim_api