Metadata-Version: 2.1
Name: whattime
Version: 0.1.1
Summary: Checking what kind of time a date is.
Home-page: https://github.com/grammofy/whattime
Author: Paul Götze
Author-email: paul.christoph.goetze@gmail.com
Maintainer: Paul Götze
Maintainer-email: paul.christoph.goetze@gmail.com
License: MIT
Description: # whattime
        
        Checking of what kind a datetime object is.
        
        whattime let’s you explore of what kind a certain datetime object is, if it e.g. is on a weekend, or in the evening.
        
        ## Getting started
        
        Install it with:
        
        ```bash
        pip install whattime
        ```
        
        or 
        
        ```bash
        pipenv install whattime
        ```
        
        For quickly getting started, just import the `whattime` function and explore a date’s properties (also see the [Get started example](https://github.com/grammofy/whattime/blob/master/examples/get_started.py)):
        
        ```python
        from datetime import datetime
        from whattime import whattime
        
        now = datetime.now()
        info = whattime(now)
        
        info.is_weekday
        info.is_monday
        # ...
        ```
        
        Besides checking all the time types you can also only check a certain category of types, e.g. info about the current day, or the time within a day seperately (also see the [Single info type example](https://github.com/grammofy/whattime/blob/master/examples/using_certain_descriptors_only.py)).
        
        ```python
        from datetime import datetime
        from whattime import week_info, day_time_info
        
        now = datetime.now()
        
        # There will only be properties available concerning the week time info when using week_info():
        info = week_info(now)
        info.is_weekday
        info.is_monday
        # ...
        
        # There will only be properties available concerning the day time info  when using day_time_info():
        info = day_time_info(now)
        info.is_afternoon
        info.is_evening
        # ...
        ```
        
        ## Development
        
        * Check out the repo with `git clone git@github.com:grammofy/whattime.git`.
        * To set up the project for development you need to [install Pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv) and run:  
          ```bash
          pipenv install --dev
          ```
          in order to install the needed development requirements.
        
        * Tests can be run with: 
          ```bash
          python setup.py test
          ```
        
        ## Contributing
        
        Bug reports, feature discussions and pull requests are welcome on GitHub at https://github.com/grammofy/whattime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant Code of Conduct](https://github.com/grammofy/whattime/blob/master/CODE_OF_CONDUCT.md).
        
        Here’s how to contribute:
        
        * Fork it (https://github.com/grammofy/whattime/fork)
        * Create your feature branch (`git checkout -b feature/my-new-feature master`)
        * Commit your changes (`git commit -am 'Add some feature'`)
        * Push to the branch (`git push origin feature/my-new-feature`)
        * Create a new Pull Request
        
        Please try to add [Pytest tests](https://pytest.org/en/latest/getting-started.html) along with your new feature. This will ensure that your code does not break existing functionality and that your feature is working as expected.
        
        ## License
        
        The software is available as open source under the terms of the [MIT License](https://github.com/grammofy/whattime/blob/master/LICENSE.txt).
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
Provides-Extra: testing
