Metadata-Version: 2.1
Name: simple-sample
Version: 0.0.1
Summary: A simple sample of a Python package prototype
Home-page: https://simple-sample.readthedocs.io/
Author: Alessandra Bilardi
Author-email: alessandra.bilardi@gmail.com
License: UNKNOWN
Project-URL: Source, https://github.com/bilardi/python-prototype
Project-URL: Bug Reports, https://github.com/bilardi/python-prototype/issues
Project-URL: Funding, https://donate.pypi.org
Description: Python prototype
        ================
        
        This package contains a simple sample of a Python package prototype.
        It is part of the `educational repositories <https://github.com/pandle/materials>`_ to learn how to write stardard code and common uses of the TDD.
        
        See the documentation and how to do it on `readthedocs <https://simple-sample.readthedocs.io/en/latest/>`_.
        And see the development of this code step by step
        
        * with `see-git-steps <https://github.com/bilardi/see-git-steps>`_
        * on `readthedocs/stepbystep <https://simple-sample.readthedocs.io/en/latest/>`_
        
        Installation
        ###############
        
        The package is self-consistent. So you can download the package by github:
        
        .. code-block:: bash
        
            $ git clone https://github.com/bilardi/python-prototype
        
        Or you can install by python3-pip:
        
        .. code-block:: bash
        
            $ pip3 install simple_sample
        
        Usage
        #####
        
        Read the unit tests in `tests/testMyClass.py <https://github.com/bilardi/python-prototype/tests/testMyClass.py>`_ file to use it. This is a best practice.
        You can read also the documentation by command line, if you download by github
        
        .. code-block:: bash
        
            $ python3
            >>> from simple_sample.myClass import MyClass
            >>> print(MyClass.__doc__)
            >>> help(MyClass)
            >>> quit()
        
        If you want to see the local documentation, that you have downloaded by github, you can use the same steps but before you must to change the directory
        
        .. code-block:: bash
        
            $ cd python-prototype
        
        Development
        ###########
        
        It is common use to test the code step by step and unittest module is a good beginning for unit test and functional test.
        
        Test with unittest module
        
        .. code-block:: bash
        
            $ cd python-prototype
            $ python3 -m unittest discover -v
        
        Change Log
        ##########
        
        See `CHANGELOG.md <https://github.com/bilardi/python-prototype/CHANGELOG.md>`_ for details.
        
        License
        #######
        
        This package is released under the MIT license.  See `LICENSE <https://github.com/bilardi/python-prototype/LICENSE>`_ for details.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
