Metadata-Version: 2.1
Name: mentormatch
Version: 0.1.2
Summary: Utility for J&J Cross-Sector Mentoring Program that matches mentors with mentees.
Home-page: https://github.com/jonathanchukinas/mentormatch
Author: Jonathan Chukinas
Author-email: chukinas@gmail.com
License: MIT license
Keywords: mentormatch
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: Click (>=6.0)

===========
mentormatch
===========


.. image:: https://img.shields.io/pypi/v/mentormatch.svg
        :target: https://pypi.python.org/pypi/mentormatch

.. image:: https://img.shields.io/travis/jonathanchukinas/mentormatch.svg
        :target: https://travis-ci.org/jonathanchukinas/mentormatch

.. image:: https://readthedocs.org/projects/mentormatch/badge/?version=latest
        :target: https://mentormatch.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status




This python application runs an algorithm to match mentors with mentees for the Cross-Sector Mentoring Program.


* Free software: MIT license
* Documentation: https://mentormatch.readthedocs.io.


Quick Start
------------

J&J Quick Start
''''''''''''''''''''''
1. **Install Python**
    a. Navigate to J&J App Store.
    #. Search ``Python``. You should see something similar to ``Python 3.6``. Add it to cart and install.
    #. No restart is required.
#. **Run Command Prompt with Elevated Privileges**
    a. Do not call IRIS.
    #. Hit the ``Windows Key`` and type ``cmd`` to search for the Windows command prompt
    #. Right-click ``cmd`` and select ``open file location``. This opens File Explorer.
    #. Right-click on the ``cmd`` icon and select ``Run with elevated privileges``.
#. **Install** ``mentormatch``
    a. In Command Prompt, type ``pip install mentormatch``
    #. If this throws an error, try instead: ``python -m pip install mentormatch``. Hint: the up-arrow accesses previous commands to reduce the amount of typing you need to do.
#. **Run** ``mentormatch``
    a. In Command Prompt, type ``mentormatch``
    #. Note: Currently, ``mentormatch`` is just a barebones script meant to test the distribution strategy. If you've gotten this far, that strategy has been a success!





Features
--------

* TODO

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.1.0 (2019-07-08)
------------------

* First release on PyPI.

0.1.1 (2019-07-08)
------------------

* README: added J&J Quick Start

0.1.2 (2019-07-09)
------------------

* bugfix: broken entry point


