README.md

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Installation
  • Tests
• Usage
• Contributing
• Contact

About The Project

Simple high-level api for all features of hebrew calendar.
Explore the swagger »

Built With

• Python 3.11
• FastAPI
• KosherJava's python port

Getting Started

To get a local copy up and running follow these simple steps.

Installation

Docker

1. Run docker run -p 8000:8000 benyomin/zmanim-api:latest
2. Open http://localhost:8000 in your browser to explore the swagger.

Python

1. Clone/fork the repo
2. Install uv and dependencies: pip install uv then uv sync (or uv sync --dev for tests)
3. Go to project folder: cd %repo_location%/zmanim_api
4. Run python main.py
5. Open http://localhost:8000 in your browser to explore the swagger

Tests

Run tests: uv run tests (or uv run pytest test/)
Run with coverage: uv run tests then uv run 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.

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

• Telegram - @benyomin
• Email

Project Link: https://github.com/benyaming/zmanim_api