LunarCalendar: A Lunar-Solar Converter
======================================
.. image::
https://img.shields.io/pypi/v/LunarCalendar.svg
:target: https://pypi.python.org/pypi/LunarCalendar
:alt: Last stable version (PyPI)
.. image::
https://travis-ci.org/wolfhong/LunarCalendar.svg
:target: https://travis-ci.org/wolfhong/LunarCalendar
:alt: build status
Overview
--------
`Chinese version(中文版) <https://github.com/wolfhong/LunarCalendar/blob/develop/README_zh.rst>`_ is provided.
LunarCalendar is a Lunar-Solar Converter, containing a number of lunar and solar festivals in China.
Korean, Japanese or Vietnamese lunar calendar is the same as Chinese calendar, but has different festivals.
Korean, Japanese and Vietnamese festivals can be easily included, with their languages.
LunarCalendar supports a time range of 1900 to 2100, which may be enough for a long time.
But if you have needs for a wider time range, you can use ``generate.html`` to extend it.
LunarCalendar is inspired by `Lunar-Solar-Calendar-Converter <https://github.com/isee15/Lunar-Solar-Calendar-Converter>`_.
Features
--------
* Accurate raw data, synchronize with Microsolf's ``ChineseLunisolarCalendar`` class
* Easy to extend festivals and languages, supported both ``zh_hans`` and ``zh_hant``
* Included Lunar Festivals, such as: MidAutumn Festival, Chinese New Year Eve, DragonBoat Festivals
* Included Solar Festivals without fixed dates, such as: Mother's Day, Easter
* Added legality check of the lunar and solar date
* Supported 24 solar terms(立春/春分/清明/冬至等)
Install
-------
LunarCalendar can be installed from the PyPI with ``easy_install``::
$ easy_install LunarCalendar
Or pip::
$ pip install LunarCalendar
If you encounter an error like ``command 'gcc' failed with exit status 1 while installing ephem``, maybe you should install ``python-devel`` first.
For CentOS::
$ yum install python-devel
For Ubuntu::
$ apt-get install python-dev
Console Commands
----------------
A console command called ``lunar-find`` can be used to find the date of the festival, using it's chinese name.
Default to this year. Supporting alias of the festival.
.. code-block:: console
$ lunar-find 重阳
重阳节 on 2018: 2018-10-17
$ lunar-find 重陽節
重阳节 on 2018: 2018-10-17
$ lunar-find 登高节 2019
重阳节 on 2019: 2019-10-07
You can also print all included festivals or 24 solar terms by date asc with:
.. code-block:: console
$ lunar-find all 2019
$ lunar-find festival 2012
$ lunar-find 节日 2012
$ lunar-find solarterm
$ lunar-find 节气
Quickstart
----------
Solar to Lunar:
.. code-block:: python
import datetime
from lunarcalendar import Converter, Solar, Lunar, DateNotExist
solar = Solar(2018, 1, 1)
print(solar)
lunar = Converter.Solar2Lunar(solar)
print(lunar)
solar = Converter.Lunar2Solar(lunar)
print(solar)
print(solar.to_date(), type(solar.to_date()))
Lunar to Solar:
.. code-block:: python
lunar = Lunar(2018, 2, 30, isleap=False)
print(lunar)
solar = Converter.Lunar2Solar(lunar)
print(solar)
lunar = Converter.Solar2Lunar(solar)
print(lunar)
print(lunar.to_date(), type(lunar.to_date()))
print(Lunar.from_date(datetime.date(2018, 4, 15)))
Legality check for solar and lunar date. 2018-2-15(Leap Month) does not exist, but 2012-4-4(Leap Month) exists:
.. code-block:: python
Lunar(2012, 4, 4, isleap=True) # date(2012, 5, 24)
try:
lunar = Lunar(2018, 2, 15, isleap=True)
except DateNotExist:
print(traceback.format_exc())
Print all the festivals included, with Chinese and English. Other languages are welcome to extend(Fork & Pull Request).
.. code-block:: python
from lunarcalendar.festival import festivals
# print festivals, using English or Chinese
print("----- print all festivals on 2018 in chinese: -----")
for fest in festivals:
print(fest.get_lang('zh'), fest(2018))
print("----- print all festivals on 2017 in english: -----")
for fest in festivals:
print(fest.get_lang('en'), fest(2017))
Output:
.. code-block:: shell
......
母亲节 2018-05-13
父亲节 2018-06-17
中秋节 2018-09-24
感恩节 2018-11-22
重阳节 2018-10-17
春节 2018-02-16
中元节 2018-08-25
七夕节 2018-08-17
腊八节 2019-01-13
清明节 2018-04-05
除夕 2019-02-04
寒衣节 2018-11-08
元宵节 2018-03-02
龙抬头 2018-03-18
端午节 2018-06-18
......
Contribution
------------
Including festival standards:
* Common festivals in the the country, such as: Christmas, Halloween, etc.
* Lunar festivals.
* Solar festivals without fixed dates, such as: Mother's Day, Easter, etc.
Supporting Chinese and English only now. If you want to add Korean, Japanese or Vietnamese supports, modify ``lunarcalendar/festival.py`` to add festivals and languages.
Some unusual festivals may not be included, `welcome to extend <https://github.com/wolfhong/LunarCalendar/issues>`_.
About
-----
* `Homepage <http://github.com/wolfhong/LunarCalendar>`_
* `PyPI <https://pypi.python.org/pypi/LunarCalendar>`_
* `Issue tracker <https://github.com/wolfhong/LunarCalendar/issues?status=new&status=open>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/wolfhong/LunarCalendar",
"name": "LunarCalendar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, <4",
"maintainer_email": "",
"keywords": "lunar calendar,festival,Chinese festivals,24 solar terms,solar calendar,lunar solar converter,lunisolar calendar",
"author": "wolfhong",
"author_email": "hongxucai1991@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/01/eb/5900632e13fa5ae7fd10127d59b3809f4586484b69c9603e624b570ccbfb/LunarCalendar-0.0.9.tar.gz",
"platform": "",
"description": "LunarCalendar: A Lunar-Solar Converter\n======================================\n\n.. image::\n https://img.shields.io/pypi/v/LunarCalendar.svg\n :target: https://pypi.python.org/pypi/LunarCalendar\n :alt: Last stable version (PyPI)\n\n.. image::\n https://travis-ci.org/wolfhong/LunarCalendar.svg\n :target: https://travis-ci.org/wolfhong/LunarCalendar\n :alt: build status\n\n\nOverview\n--------\n\n`Chinese version(\u4e2d\u6587\u7248) <https://github.com/wolfhong/LunarCalendar/blob/develop/README_zh.rst>`_ is provided.\n\nLunarCalendar is a Lunar-Solar Converter, containing a number of lunar and solar festivals in China.\n\nKorean, Japanese or Vietnamese lunar calendar is the same as Chinese calendar, but has different festivals.\nKorean, Japanese and Vietnamese festivals can be easily included, with their languages.\n\nLunarCalendar supports a time range of 1900 to 2100, which may be enough for a long time.\nBut if you have needs for a wider time range, you can use ``generate.html`` to extend it.\n\nLunarCalendar is inspired by `Lunar-Solar-Calendar-Converter <https://github.com/isee15/Lunar-Solar-Calendar-Converter>`_.\n\n\nFeatures\n--------\n\n* Accurate raw data, synchronize with Microsolf's ``ChineseLunisolarCalendar`` class\n* Easy to extend festivals and languages, supported both ``zh_hans`` and ``zh_hant``\n* Included Lunar Festivals, such as: MidAutumn Festival, Chinese New Year Eve, DragonBoat Festivals\n* Included Solar Festivals without fixed dates, such as: Mother's Day, Easter\n* Added legality check of the lunar and solar date\n* Supported 24 solar terms(\u7acb\u6625/\u6625\u5206/\u6e05\u660e/\u51ac\u81f3\u7b49)\n\n\nInstall\n-------\n\nLunarCalendar can be installed from the PyPI with ``easy_install``::\n\n $ easy_install LunarCalendar\n\nOr pip::\n\n $ pip install LunarCalendar\n\nIf you encounter an error like ``command 'gcc' failed with exit status 1 while installing ephem``, maybe you should install ``python-devel`` first.\nFor CentOS::\n\n $ yum install python-devel\n\nFor Ubuntu::\n\n $ apt-get install python-dev\n\n\nConsole Commands\n----------------\n\nA console command called ``lunar-find`` can be used to find the date of the festival, using it's chinese name.\nDefault to this year. Supporting alias of the festival.\n\n.. code-block:: console\n\n $ lunar-find \u91cd\u9633\n \u91cd\u9633\u8282 on 2018: 2018-10-17\n\n $ lunar-find \u91cd\u967d\u7bc0\n \u91cd\u9633\u8282 on 2018: 2018-10-17\n\n $ lunar-find \u767b\u9ad8\u8282 2019\n \u91cd\u9633\u8282 on 2019: 2019-10-07\n\nYou can also print all included festivals or 24 solar terms by date asc with:\n\n.. code-block:: console\n\n $ lunar-find all 2019\n $ lunar-find festival 2012\n $ lunar-find \u8282\u65e5 2012\n $ lunar-find solarterm\n $ lunar-find \u8282\u6c14\n\n\nQuickstart\n----------\n\nSolar to Lunar:\n\n.. code-block:: python\n\n import datetime\n from lunarcalendar import Converter, Solar, Lunar, DateNotExist\n\n solar = Solar(2018, 1, 1)\n print(solar)\n lunar = Converter.Solar2Lunar(solar)\n print(lunar)\n solar = Converter.Lunar2Solar(lunar)\n print(solar)\n print(solar.to_date(), type(solar.to_date()))\n\nLunar to Solar:\n\n.. code-block:: python\n\n lunar = Lunar(2018, 2, 30, isleap=False)\n print(lunar)\n solar = Converter.Lunar2Solar(lunar)\n print(solar)\n lunar = Converter.Solar2Lunar(solar)\n print(lunar)\n print(lunar.to_date(), type(lunar.to_date()))\n print(Lunar.from_date(datetime.date(2018, 4, 15)))\n\nLegality check for solar and lunar date. 2018-2-15(Leap Month) does not exist, but 2012-4-4(Leap Month) exists:\n\n.. code-block:: python\n\n Lunar(2012, 4, 4, isleap=True) # date(2012, 5, 24)\n try:\n lunar = Lunar(2018, 2, 15, isleap=True)\n except DateNotExist:\n print(traceback.format_exc())\n\nPrint all the festivals included, with Chinese and English. Other languages are welcome to extend(Fork & Pull Request).\n\n.. code-block:: python\n\n from lunarcalendar.festival import festivals\n\n # print festivals, using English or Chinese\n print(\"----- print all festivals on 2018 in chinese: -----\")\n for fest in festivals:\n print(fest.get_lang('zh'), fest(2018))\n\n print(\"----- print all festivals on 2017 in english: -----\")\n for fest in festivals:\n print(fest.get_lang('en'), fest(2017))\n\nOutput:\n\n.. code-block:: shell\n\n ......\n \u6bcd\u4eb2\u8282 2018-05-13\n \u7236\u4eb2\u8282 2018-06-17\n \u4e2d\u79cb\u8282 2018-09-24\n \u611f\u6069\u8282 2018-11-22\n \u91cd\u9633\u8282 2018-10-17\n \u6625\u8282 2018-02-16\n \u4e2d\u5143\u8282 2018-08-25\n \u4e03\u5915\u8282 2018-08-17\n \u814a\u516b\u8282 2019-01-13\n \u6e05\u660e\u8282 2018-04-05\n \u9664\u5915 2019-02-04\n \u5bd2\u8863\u8282 2018-11-08\n \u5143\u5bb5\u8282 2018-03-02\n \u9f99\u62ac\u5934 2018-03-18\n \u7aef\u5348\u8282 2018-06-18\n ......\n\n\nContribution\n------------\n\nIncluding festival standards:\n\n* Common festivals in the the country, such as: Christmas, Halloween, etc.\n* Lunar festivals.\n* Solar festivals without fixed dates, such as: Mother's Day, Easter, etc.\n\nSupporting Chinese and English only now. If you want to add Korean, Japanese or Vietnamese supports, modify ``lunarcalendar/festival.py`` to add festivals and languages.\n\nSome unusual festivals may not be included, `welcome to extend <https://github.com/wolfhong/LunarCalendar/issues>`_.\n\n\n\nAbout\n-----\n\n* `Homepage <http://github.com/wolfhong/LunarCalendar>`_\n* `PyPI <https://pypi.python.org/pypi/LunarCalendar>`_\n* `Issue tracker <https://github.com/wolfhong/LunarCalendar/issues?status=new&status=open>`_\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A lunar calendar converter, including a number of lunar and solar holidays, mainly from China.",
"version": "0.0.9",
"project_urls": {
"Homepage": "https://github.com/wolfhong/LunarCalendar"
},
"split_keywords": [
"lunar calendar",
"festival",
"chinese festivals",
"24 solar terms",
"solar calendar",
"lunar solar converter",
"lunisolar calendar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abe0a52ffc02395474858552ca6437226e23ad67e25fd85cb387f02e479cfe01",
"md5": "2798af0411132ce12c6543bff6a0dd43",
"sha256": "5ef25883d73898b37edb54da9e0f04215aaa68b897fd12e9d4b79756ff91c8cb"
},
"downloads": -1,
"filename": "LunarCalendar-0.0.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2798af0411132ce12c6543bff6a0dd43",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7, <4",
"size": 18280,
"upload_time": "2018-06-13T12:01:21",
"upload_time_iso_8601": "2018-06-13T12:01:21.466645Z",
"url": "https://files.pythonhosted.org/packages/ab/e0/a52ffc02395474858552ca6437226e23ad67e25fd85cb387f02e479cfe01/LunarCalendar-0.0.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01eb5900632e13fa5ae7fd10127d59b3809f4586484b69c9603e624b570ccbfb",
"md5": "ee3faced40d85637f00ce47cf4a554b6",
"sha256": "681142f22fc353c3abca4b25699e3d1aa7083ad1c268dce36ba297eca04bed5a"
},
"downloads": -1,
"filename": "LunarCalendar-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "ee3faced40d85637f00ce47cf4a554b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, <4",
"size": 18019,
"upload_time": "2018-06-13T12:01:22",
"upload_time_iso_8601": "2018-06-13T12:01:22.982700Z",
"url": "https://files.pythonhosted.org/packages/01/eb/5900632e13fa5ae7fd10127d59b3809f4586484b69c9603e624b570ccbfb/LunarCalendar-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2018-06-13 12:01:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wolfhong",
"github_project": "LunarCalendar",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "lunarcalendar"
}
JSON
