Metadata-Version: 2.1
Name: datemore
Version: 1.0.1
Summary: No description has been added so far.
Home-page: https://github.com/romnn/datemore
Author: romnn
Author-email: contact@romnn.com
License: MIT
Keywords: datemore
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Requires-Dist: Click (>=6.0)
Requires-Dist: pytz
Provides-Extra: dev
Requires-Dist: Click (>=6.0) ; extra == 'dev'
Requires-Dist: pytz ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-xdist ; extra == 'dev'
Requires-Dist: pytest-sugar ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pyfakefs ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Requires-Dist: codecov ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: black (==19.10b0) ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: m2r ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: invoke ; extra == 'dev'
Requires-Dist: ruamel.yaml ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: cookiecutter ; extra == 'dev'
Requires-Dist: bump2version ; extra == 'dev'
Provides-Extra: test
Requires-Dist: tox ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-xdist ; extra == 'test'
Requires-Dist: pytest-sugar ; extra == 'test'
Requires-Dist: mypy ; extra == 'test'
Requires-Dist: pyfakefs ; extra == 'test'

===============================
datemore
===============================

.. image:: https://github.com/romnn/datemore/workflows/test/badge.svg
        :target: https://github.com/romnn/datemore/actions
        :alt: Build Status

.. image:: https://img.shields.io/pypi/v/datemore.svg
        :target: https://pypi.python.org/pypi/datemore
        :alt: PyPI version

.. image:: https://img.shields.io/github/license/romnn/datemore
        :target: https://github.com/romnn/datemore
        :alt: License

.. image:: https://codecov.io/gh/romnn/datemore/branch/master/graph/badge.svg
        :target: https://codecov.io/gh/romnn/datemore
        :alt: Test Coverage

""""""""

This is a small python package that wraps useful extension helper methods
around the standard library ``datetime`` package.

.. code-block:: console

    $ pip install datemore

This package extends ``date`` and ``datetime`` objects with
useful methods for:

- Localizing ``date`` and ``datetime`` objects
- Adding and subtracting
- Generating date ranges
- Mocking (you cannot mock builtins, so why not use this library in the first place :wink:)

Example:

.. code-block:: python

    import datemore.date
    sunday = datemore.date.Date(2020, 2, 2)
    tuesday = sunday.add_days(2)
    passed_days = sunday.range_to(tuesday)
    tuesday.native()  # Get the native datetime.date object

Do you want to add new extensions? Go ahead!
Contributions are welcome, have a look at `CONTRIBUTING <CONTRIBUTING.rst>`_.

Development
-----------

For detailed instructions see `CONTRIBUTING <CONTRIBUTING.rst>`_.

Tests
~~~~~~~
You can run tests with

.. code-block:: console

    $ invoke test
    $ invoke test --min-coverage=90     # Fail when code coverage is below 90%
    $ invoke type-check                 # Run mypy type checks

Linting and formatting
~~~~~~~~~~~~~~~~~~~~~~~~
Lint and format the code with

.. code-block:: console

    $ invoke format
    $ invoke lint

All of this happens when you run ``invoke pre-commit``.

Note
-----

This project is still in the alpha stage and should not be considered production ready.


