Metadata-Version: 2.1
Name: journal-software-engineering
Version: 0.0.7
Summary: journal_software_engineering
Home-page: https://github.com/sagersmith8/journal_software_engineering
Author: Sage Smith
Author-email: sagersmith8@gmail.com
License: Apache Software License 2.0
Project-URL: Changelog, https://github.com/sagersmith8/journal_software_engineering/blob/master/CHANGELOG.rst
Project-URL: Issue Tracker, https://github.com/sagersmith8/journal_software_engineering/issues
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: gitpython
Requires-Dist: colorama
Requires-Dist: pandas

========
Overview
========



journal_software_engineering

* Free software: Apache Software License 2.0

Installation
============

.. code-block:: bash
    pip install journal-software-engineering

Documentation
=============


To use the project:

.. code-block:: python

    import journal_software_engineering
    journal_software_engineering -h


.. code-block:: bash

    usage: journal [-h] [-t] [-d] [-n] [-c] [-s] [-j] [-b BEFORE] [-a AFTER]
                   [entry]

            journal makes commits to repos in the following locations:
                journal location: /Users/sagesmith/.journal
                notes location: /Users/sagesmith/.journal/.notes
                ticket location: /Users/sagesmith/.journal/.ticket
                todo location: /Users/sagesmith/.journal/.todo

    positional arguments:
      entry                 entry to enter in journal

    optional arguments:
      -h, --help            show this help message and exit
      -t, --ticket          specifies ticket journal
      -d, --do              specifies todo journal
      -n, --note            specifies note journal
      -s, --standup         prints stand up
      -j, --journal         specifies entire journal
      -b BEFORE, --before BEFORE
                            specifies to grab standup logs before entered date
      -a AFTER, --after AFTER
                            specifies to grab standup logs after entered date

    made by sage smith



Development
===========

To run the all tests run::

    tox

Note, to combine the coverage data from all the tox environments run:

.. list-table::
    :widths: 10 90
    :stub-columns: 1

    - - Windows
      - ::

            set PYTEST_ADDOPTS=--cov-append
            tox

    - - Other
      - ::

            PYTEST_ADDOPTS=--cov-append tox


Changelog
=========

0.1.0 (2019-02-26)
------------------

* First release on PyPI.


