Metadata-Version: 2.1
Name: jira-freeplane
Version: 1.0.9
Summary: Make JIRA Epics, Tasks, and Sub-tasks via a freeplane mindmap
Home-page: https://github.com/shollingsworth/jira-freeplane
License: MIT
Keywords: jira,freeplane,mindmap,mindmapping
Author: Stevo
Author-email: hollingsworth.stevend@gmail.com
Maintainer: Stevo
Maintainer-email: hollingsworth.stevend@gmail.com
Requires-Python: >=3.8,<4
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: PyYAML (>=5.4.1,<7)
Requires-Dist: jira (>=3.1.1,<4)
Requires-Dist: simple-term-menu (<=1.4.1)
Requires-Dist: untangle (>=1.1.1,<2)
Requires-Dist: urllib3 (>=1.26.5,<2)
Project-URL: Repository, https://github.com/shollingsworth/jira-freeplane
Description-Content-Type: text/x-rst

JIRA Freeplane issue creator
=============================

.. contents:: Page Contents

Software Requirements
---------------------
- `Freeplane <http://freeplane.sourceforge.net/>`_
- Pick one
    - `Python <http://www.python.org/>`_
    - `Docker <https://www.docker.com/>`_


Installation
------------

Python
^^^^^^
.. code:: bash

    pip install jira_freeplane

Docker - `jira-freeplane <https://hub.docker.com/r/hollingsworthsteven/jira-freeplane/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: bash

    docker pull hollingsworthsteven/jira-freeplane

Quickstart
----------

- Create a new mindmap, see `sample.mm <https://github.com/shollingsworth/jira-freeplane/blob/main/examples/sample.mm>`_ 
  as an example.


docker (interactive mode)
^^^^^^^^^^^^^^^^^^^^^^^^^

.. tip:: 

    This assumes you are running bash or zsh as your shell

    Replace ``$mindmap`` with the file name / path of your mindmap.

    Replace ``$JIRA_USER``, and ``$JIRA_PASS`` with your JIRA credentials.

    (You can also use environment variables if you do not want them to show in
    your command history)

    do not change ``/config/freeplane_doc.mm`` only ``$mindmap``

.. code:: bash

    docker run --rm -it -v "$(pwd):/app" -v "$mindmap:/config/freeplane_doc.mm" -e "JIRA_USER=${JIRA_USER}" -e "JIRA_PASS=${JIRA_PASS}" -u "$(id -u):$(id -g)" hollingsworthsteven/jira-freeplane jira-freeplane --interactive /config/freeplane_doc.mm


python/pip
^^^^^^^^^^

.. tip:: 

   replace

   ``<your_jira_username>``

   and

   ``<your_jira_password>``

   with your JIRA credentials.

.. code:: bash

    pip install jira_freeplane
    export JIRA_USER=<your_jira_username>
    export JIRA_PASS=<your_jira_password>
    jira-freeplane -i /path/to/mindmap.mm


Contribute
----------
Pull requests are welcome!

- `Issue Tracker <https://github.com/shollingsworth/jira-freeplane/issues>`_
- `Source Code <github.com/shollingsworth/jira-freeplane>`_

Support
-------

Unfortunately, there is no support for this project. We do welcome
contributions and pull requests though!


License
-------

The project is licensed under the MIT license.
see `LICENSE <https://github.com/shollingsworth/jira-freeplane/blob/main/LICENSE.txt>`_

