ics


Nameics JSON
Version 0.7.2 PyPI version JSON
download
home_pagehttp://github.com/C4ptainCrunch/ics.py
SummaryPython icalendar (rfc5545) parser
upload_time2022-07-06 11:25:41
maintainer
docs_urlNone
authorNikita Marchant
requires_python
licenseApache License, Version 2.0
keywords ics icalendar calendar event todo rfc5545 parser pythonic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Ics.py : iCalendar for Humans
=============================

`Original repository <https://github.com/C4ptainCrunch/ics.py>`_ (GitHub) -
`Bugtracker and issues <https://github.com/C4ptainCrunch/ics.py/issues>`_ (GitHub) -
`PyPi package <https://pypi.python.org/pypi/ics/>`_ (ics) -
`Documentation <http://icspy.readthedocs.org/>`_ (Read The Docs).


.. image:: https://img.shields.io/github/license/c4ptaincrunch/ics.py.svg
    :target: https://pypi.python.org/pypi/ics/
    :alt: Apache 2 License


Ics.py is a pythonic and easy iCalendar library.
Its goals are to read and write ics data in a developer friendly way.

iCalendar is a widely-used and useful format but not user friendly.
Ics.py is there to give you the ability of creating and reading this
format without any knowledge of it.

It should be able to parse every calendar that respects the
`rfc5545 <http://tools.ietf.org/html/rfc5545>`_ and maybe some moreā€¦
It also outputs rfc compliant calendars.

iCalendar (file extension `.ics`) is used by Google Calendar,
Apple Calendar, Android and many more.


Ics.py is available for Python>=3.6 and is Apache2 Licensed.



Quickstart
----------

.. code-block:: bash

    $ pip install ics



.. code-block:: python

    from ics import Calendar, Event
    c = Calendar()
    e = Event()
    e.name = "My cool event"
    e.begin = '2014-01-01 00:00:00'
    c.events.add(e)
    c.events
    # [<Event 'My cool event' begin:2014-01-01 00:00:00 end:2014-01-01 00:00:01>]
    with open('my.ics', 'w') as my_file:
        my_file.writelines(c.serialize_iter())
    # and it's done !

More examples are available in the
`documentation <http://icspy.readthedocs.org/>`_.

Documentation
-------------

All the `documentation <http://icspy.readthedocs.org/>`_ is hosted on
`readthedocs.org <http://readthedocs.org/>`_ and is updated automatically
at every commit.

* `Quickstart <http://icspy.readthedocs.org/>`_
* `API <http://icspy.readthedocs.org/en/latest/api.html>`_
* `About <http://icspy.readthedocs.org/en/latest/about.html>`_


Contribute
----------

Contribution are welcome of course! For more information, see
`contributing <https://github.com/C4ptainCrunch/ics.py/blob/master/CONTRIBUTING.rst>`_.


Testing & Docs
--------------

.. code-block:: bash

    # setup virtual environment
    $ sudo pip install virtualenv
    $ virtualenv ve
    $ source ve/bin/activate

    # tests
    $ pip install -r requirements.txt
    $ pip install -r dev/requirements-test.txt
    $ python setup.py test

    # tests coverage
    $ pip install -r requirements.txt
    $ pip install -r dev/requirements-test.txt
    $ python setup.py test
    $ coverage html
    $ firefox htmlcov/index.html

    # docs
    $ pip install -r requirements.txt
    $ pip install -r dev/requirements-doc.txt
    $ cd doc
    $ make html


Links
-----
* `rfc5545 <http://tools.ietf.org/html/rfc5545>`_
* `Vulgarised RFC <http://www.kanzaki.com/docs/ical/>`_

.. image:: http://i.imgur.com/KnSQg48.jpg
    :target: https://github.com/C4ptainCrunch/ics.py
    :alt: Parse ALL the calendars!
    :align: center

            

Raw data

            {
    "_id": null,
    "home_page": "http://github.com/C4ptainCrunch/ics.py",
    "name": "ics",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "ics icalendar calendar event todo rfc5545 parser pythonic",
    "author": "Nikita Marchant",
    "author_email": "nikita.marchant@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/43/fa/2cb7cbe23566140f011da4fec280d4873da4389c8b838bb3e5ce3fc39b16/ics-0.7.2.tar.gz",
    "platform": null,
    "description": "Ics.py : iCalendar for Humans\n=============================\n\n`Original repository <https://github.com/C4ptainCrunch/ics.py>`_ (GitHub) -\n`Bugtracker and issues <https://github.com/C4ptainCrunch/ics.py/issues>`_ (GitHub) -\n`PyPi package <https://pypi.python.org/pypi/ics/>`_ (ics) -\n`Documentation <http://icspy.readthedocs.org/>`_ (Read The Docs).\n\n\n.. image:: https://img.shields.io/github/license/c4ptaincrunch/ics.py.svg\n    :target: https://pypi.python.org/pypi/ics/\n    :alt: Apache 2 License\n\n\nIcs.py is a pythonic and easy iCalendar library.\nIts goals are to read and write ics data in a developer friendly way.\n\niCalendar is a widely-used and useful format but not user friendly.\nIcs.py is there to give you the ability of creating and reading this\nformat without any knowledge of it.\n\nIt should be able to parse every calendar that respects the\n`rfc5545 <http://tools.ietf.org/html/rfc5545>`_ and maybe some more\u2026\nIt also outputs rfc compliant calendars.\n\niCalendar (file extension `.ics`) is used by Google Calendar,\nApple Calendar, Android and many more.\n\n\nIcs.py is available for Python>=3.6 and is Apache2 Licensed.\n\n\n\nQuickstart\n----------\n\n.. code-block:: bash\n\n    $ pip install ics\n\n\n\n.. code-block:: python\n\n    from ics import Calendar, Event\n    c = Calendar()\n    e = Event()\n    e.name = \"My cool event\"\n    e.begin = '2014-01-01 00:00:00'\n    c.events.add(e)\n    c.events\n    # [<Event 'My cool event' begin:2014-01-01 00:00:00 end:2014-01-01 00:00:01>]\n    with open('my.ics', 'w') as my_file:\n        my_file.writelines(c.serialize_iter())\n    # and it's done !\n\nMore examples are available in the\n`documentation <http://icspy.readthedocs.org/>`_.\n\nDocumentation\n-------------\n\nAll the `documentation <http://icspy.readthedocs.org/>`_ is hosted on\n`readthedocs.org <http://readthedocs.org/>`_ and is updated automatically\nat every commit.\n\n* `Quickstart <http://icspy.readthedocs.org/>`_\n* `API <http://icspy.readthedocs.org/en/latest/api.html>`_\n* `About <http://icspy.readthedocs.org/en/latest/about.html>`_\n\n\nContribute\n----------\n\nContribution are welcome of course! For more information, see\n`contributing <https://github.com/C4ptainCrunch/ics.py/blob/master/CONTRIBUTING.rst>`_.\n\n\nTesting & Docs\n--------------\n\n.. code-block:: bash\n\n    # setup virtual environment\n    $ sudo pip install virtualenv\n    $ virtualenv ve\n    $ source ve/bin/activate\n\n    # tests\n    $ pip install -r requirements.txt\n    $ pip install -r dev/requirements-test.txt\n    $ python setup.py test\n\n    # tests coverage\n    $ pip install -r requirements.txt\n    $ pip install -r dev/requirements-test.txt\n    $ python setup.py test\n    $ coverage html\n    $ firefox htmlcov/index.html\n\n    # docs\n    $ pip install -r requirements.txt\n    $ pip install -r dev/requirements-doc.txt\n    $ cd doc\n    $ make html\n\n\nLinks\n-----\n* `rfc5545 <http://tools.ietf.org/html/rfc5545>`_\n* `Vulgarised RFC <http://www.kanzaki.com/docs/ical/>`_\n\n.. image:: http://i.imgur.com/KnSQg48.jpg\n    :target: https://github.com/C4ptainCrunch/ics.py\n    :alt: Parse ALL the calendars!\n    :align: center\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Python icalendar (rfc5545) parser",
    "version": "0.7.2",
    "split_keywords": [
        "ics",
        "icalendar",
        "calendar",
        "event",
        "todo",
        "rfc5545",
        "parser",
        "pythonic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a95e04dea5cf29bdf5005f5aa7ccf0a2f9724b877722d89f8286dc3785a7cdc",
                "md5": "0e6e3b668414464f9a6ac1ada312edb8",
                "sha256": "5fcf4d29ec6e7dfcb84120abd617bbba632eb77b097722b7df70e48dbcf26103"
            },
            "downloads": -1,
            "filename": "ics-0.7.2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0e6e3b668414464f9a6ac1ada312edb8",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 40086,
            "upload_time": "2022-07-06T11:25:36",
            "upload_time_iso_8601": "2022-07-06T11:25:36.536824Z",
            "url": "https://files.pythonhosted.org/packages/0a/95/e04dea5cf29bdf5005f5aa7ccf0a2f9724b877722d89f8286dc3785a7cdc/ics-0.7.2-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "61d6117ff9f1a71dcf3eb84ea0e204548b20dda110408fc7e03e51e1226f0e64",
                "md5": "bdb1537d4bef355ea1a99b02b21aa0fb",
                "sha256": "da352bdf8418619dc93611e6d251f3cefbb42664777f6e00b580a722098124b7"
            },
            "downloads": -1,
            "filename": "ics-0.7.2-py3.9.egg",
            "has_sig": false,
            "md5_digest": "bdb1537d4bef355ea1a99b02b21aa0fb",
            "packagetype": "bdist_egg",
            "python_version": "0.7.2",
            "requires_python": null,
            "size": 90694,
            "upload_time": "2022-07-06T11:25:38",
            "upload_time_iso_8601": "2022-07-06T11:25:38.572636Z",
            "url": "https://files.pythonhosted.org/packages/61/d6/117ff9f1a71dcf3eb84ea0e204548b20dda110408fc7e03e51e1226f0e64/ics-0.7.2-py3.9.egg",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "43fa2cb7cbe23566140f011da4fec280d4873da4389c8b838bb3e5ce3fc39b16",
                "md5": "27140dd10fa8b359cc95de0b5d9bc1c8",
                "sha256": "6743539bca10391635249b87d74fcd1094af20b82098bebf7c7521df91209f05"
            },
            "downloads": -1,
            "filename": "ics-0.7.2.tar.gz",
            "has_sig": false,
            "md5_digest": "27140dd10fa8b359cc95de0b5d9bc1c8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 190643,
            "upload_time": "2022-07-06T11:25:41",
            "upload_time_iso_8601": "2022-07-06T11:25:41.666493Z",
            "url": "https://files.pythonhosted.org/packages/43/fa/2cb7cbe23566140f011da4fec280d4873da4389c8b838bb3e5ce3fc39b16/ics-0.7.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-07-06 11:25:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "C4ptainCrunch",
    "github_project": "ics.py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "ics"
}
        
Elapsed time: 0.07088s