Skip to main content

journal_software_engineering

Project description

========
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.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

journal-software-engineering-0.0.9.tar.gz (21.3 kB view hashes)

Uploaded Source

Built Distribution

journal_software_engineering-0.0.9-py2.py3-none-any.whl (10.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page