jewcal


Namejewcal JSON
Version 0.8.0 PyPI version JSON
download
home_pageNone
SummaryConvert Gregorian to Jewish dates with holidays and zmanim (Diaspora/Israel).
upload_time2024-12-20 11:18:00
maintainerNone
docs_urlNone
authoressel-dev
requires_python>=3.10
licenseMIT License Copyright (c) 2022 essel-dev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords jewish calendar hebrew calendar zmanim
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. include_title_start

JewCal
======

.. include_title_end



.. image:: https://github.com/essel-dev/jewcal/actions/workflows/tests.yml/badge.svg
    :target: https://github.com/essel-dev/jewcal/actions/workflows/tests.yml
    :alt: Tests Status
.. image:: https://github.com/essel-dev/jewcal/actions/workflows/pypi.yml/badge.svg
    :target: https://github.com/essel-dev/jewcal/actions/workflows/pypi.yml
    :alt: PyPi Status
.. image:: https://readthedocs.org/projects/jewcal/badge/?version=latest
    :target: https://jewcal.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

|



.. include_intro_start

Convert Gregorian to Jewish dates with holidays and zmanim (Diaspora/Israel).

Get info about:

* The Jewish date
* Shabbos and Yom Tov events
* The action (`Candles` or `Havdalah`)
* The zmanim

  * Sunrise
  * Sunset
  * Plag Hamincha
  * Hadlokas Haneiros (adjust the minutes before sunset)
  * Tzeis (adjust to stars or minutes after sunset)


Determine whether it is:

* Erev Shabbos or Erev Yom Tov
* Shabbos
* Yom Tov
* Issur Melacha

If latitude and longitude are specified, nightfall is taken into account to calculate
the Jewish date.


.. include_intro_end



.. include_quickstart_start

Quickstart
----------

Install JewCal using pip:

.. code-block:: bash

  pip install jewcal


Run in the console:

.. code-block:: bash

  jewcal


The output:

.. code-block:: console

  Today is 23 Iyar 5784

  today.has_events()=True
  today.is_erev()=True
  today.is_erev_shabbos()=True
  today.is_shabbos()=False
  today.is_erev_yomtov()=False
  today.is_yomtov()=False
  today.is_issur_melacha()=False

  JewCal(
    jewish_date=JewishDate(
      year=5784, month=2, day=23,
      gregorian_date=datetime.date(2024, 5, 31)
    ),
    events=Events(
      shabbos='Erev Shabbos',
      yomtov=None,
      action='Candles'
    ),
    diaspora=True,
    zmanim=None
  )


  Zmanim for Jerushalayim:
  {
    'hadlokas_haneiros': '2024-05-31T15:59:12.468117+00:00',
    'plag_hamincha': '2024-05-31T15:11:15.201081+00:00',
    'sunrise': '2024-05-31T02:34:50.704559+00:00',
    'sunset': '2024-05-31T16:39:12.468117+00:00',
    'tzeis_hakochavim': '2024-05-31T17:21:11.859783+00:00',
    'tzeis_minutes': '2024-05-31T17:51:12.468117+00:00'
  }

  Location(
    latitude=31.76904, longitude=35.21633,
    use_tzeis_hakochavim=True,
    hadlokas_haneiros_minutes=40,
    tzeis_minutes=72
  )


.. include_quickstart_end


Resources
---------

- `JewCal @ PyPI <https://pypi.org/project/jewcal/>`_
- `JewCal @ Read the Docs <https://jewcal.readthedocs.io/>`_

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "jewcal",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "jewish calendar, hebrew calendar, zmanim",
    "author": "essel-dev",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/4d/7e/1383bccaa4c2b6e2a3999d62488c9d013bf672e68284fbc4bfde65c82dc7/jewcal-0.8.0.tar.gz",
    "platform": null,
    "description": ".. include_title_start\n\nJewCal\n======\n\n.. include_title_end\n\n\n\n.. image:: https://github.com/essel-dev/jewcal/actions/workflows/tests.yml/badge.svg\n    :target: https://github.com/essel-dev/jewcal/actions/workflows/tests.yml\n    :alt: Tests Status\n.. image:: https://github.com/essel-dev/jewcal/actions/workflows/pypi.yml/badge.svg\n    :target: https://github.com/essel-dev/jewcal/actions/workflows/pypi.yml\n    :alt: PyPi Status\n.. image:: https://readthedocs.org/projects/jewcal/badge/?version=latest\n    :target: https://jewcal.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n|\n\n\n\n.. include_intro_start\n\nConvert Gregorian to Jewish dates with holidays and zmanim (Diaspora/Israel).\n\nGet info about:\n\n* The Jewish date\n* Shabbos and Yom Tov events\n* The action (`Candles` or `Havdalah`)\n* The zmanim\n\n  * Sunrise\n  * Sunset\n  * Plag Hamincha\n  * Hadlokas Haneiros (adjust the minutes before sunset)\n  * Tzeis (adjust to stars or minutes after sunset)\n\n\nDetermine whether it is:\n\n* Erev Shabbos or Erev Yom Tov\n* Shabbos\n* Yom Tov\n* Issur Melacha\n\nIf latitude and longitude are specified, nightfall is taken into account to calculate\nthe Jewish date.\n\n\n.. include_intro_end\n\n\n\n.. include_quickstart_start\n\nQuickstart\n----------\n\nInstall JewCal using pip:\n\n.. code-block:: bash\n\n  pip install jewcal\n\n\nRun in the console:\n\n.. code-block:: bash\n\n  jewcal\n\n\nThe output:\n\n.. code-block:: console\n\n  Today is 23 Iyar 5784\n\n  today.has_events()=True\n  today.is_erev()=True\n  today.is_erev_shabbos()=True\n  today.is_shabbos()=False\n  today.is_erev_yomtov()=False\n  today.is_yomtov()=False\n  today.is_issur_melacha()=False\n\n  JewCal(\n    jewish_date=JewishDate(\n      year=5784, month=2, day=23,\n      gregorian_date=datetime.date(2024, 5, 31)\n    ),\n    events=Events(\n      shabbos='Erev Shabbos',\n      yomtov=None,\n      action='Candles'\n    ),\n    diaspora=True,\n    zmanim=None\n  )\n\n\n  Zmanim for Jerushalayim:\n  {\n    'hadlokas_haneiros': '2024-05-31T15:59:12.468117+00:00',\n    'plag_hamincha': '2024-05-31T15:11:15.201081+00:00',\n    'sunrise': '2024-05-31T02:34:50.704559+00:00',\n    'sunset': '2024-05-31T16:39:12.468117+00:00',\n    'tzeis_hakochavim': '2024-05-31T17:21:11.859783+00:00',\n    'tzeis_minutes': '2024-05-31T17:51:12.468117+00:00'\n  }\n\n  Location(\n    latitude=31.76904, longitude=35.21633,\n    use_tzeis_hakochavim=True,\n    hadlokas_haneiros_minutes=40,\n    tzeis_minutes=72\n  )\n\n\n.. include_quickstart_end\n\n\nResources\n---------\n\n- `JewCal @ PyPI <https://pypi.org/project/jewcal/>`_\n- `JewCal @ Read the Docs <https://jewcal.readthedocs.io/>`_\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022 essel-dev  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Convert Gregorian to Jewish dates with holidays and zmanim (Diaspora/Israel).",
    "version": "0.8.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/essel-dev/jewcal/issues",
        "Changelog": "https://github.com/essel-dev/jewcal/releases",
        "Documentation": "https://jewcal.readthedocs.io/",
        "GitHub": "https://github.com/essel-dev/jewcal"
    },
    "split_keywords": [
        "jewish calendar",
        " hebrew calendar",
        " zmanim"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "813dcf0a669493ff93c8ea4b817ced1896cd70f8f0d1cd57c769b65d5be2a3ec",
                "md5": "cc000deaa36f334eabab17c73f1b1ce1",
                "sha256": "1b91b690046d6a09ec4e0f8cd179689a5e20177fc4be173b886c22bfad06d415"
            },
            "downloads": -1,
            "filename": "jewcal-0.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cc000deaa36f334eabab17c73f1b1ce1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 17107,
            "upload_time": "2024-12-20T11:17:57",
            "upload_time_iso_8601": "2024-12-20T11:17:57.836819Z",
            "url": "https://files.pythonhosted.org/packages/81/3d/cf0a669493ff93c8ea4b817ced1896cd70f8f0d1cd57c769b65d5be2a3ec/jewcal-0.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4d7e1383bccaa4c2b6e2a3999d62488c9d013bf672e68284fbc4bfde65c82dc7",
                "md5": "3e93f64799fa60acb4660a9d78c39404",
                "sha256": "e5497ee60fbfa3a5830e465698fd0ca64e41301016c82c73fadda873b1f836bf"
            },
            "downloads": -1,
            "filename": "jewcal-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3e93f64799fa60acb4660a9d78c39404",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 15757,
            "upload_time": "2024-12-20T11:18:00",
            "upload_time_iso_8601": "2024-12-20T11:18:00.343797Z",
            "url": "https://files.pythonhosted.org/packages/4d/7e/1383bccaa4c2b6e2a3999d62488c9d013bf672e68284fbc4bfde65c82dc7/jewcal-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-20 11:18:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "essel-dev",
    "github_project": "jewcal",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "jewcal"
}
        
Elapsed time: 0.38032s