Metadata-Version: 2.1
Name: ryerrabelli
Version: 1.0.61
Summary: See long description
Home-page: https://github.com/ryerrabelli/ryerrabelli
Author: Rahul Yerrabelli
Author-email: ryerrabelli+python@gmail.com
License: UNKNOWN
Description: # App
        
        
        ## Installation
        
        
        ## File Structure
        Standard file structure for python packages as follows:  
        * `<main folder name>`
          * *docs/*  
            * **[LICENSE.txt](../docs/LICENSE.txt)**
            * **[README.md](../docs/LICENSE.txt)**         _<- .rst file type preferred in python, but .md is more common overall_
          * *src/*  <- dedicated src is not always done but recommended for compatibility
            * `<module name>`       _<- often the same name as the main folder, but should be a subfolder_
              * `__init__.py`       _<- an empty file can be all that's needed at times. However, importing items here can be useful as they will be accessible to any file that is importing the overall module_ 
              * `_version.py`       _<- autogenerated by versioneer using info from setup.cfg [^1]_
              * `main.py`
              * `utils.py`
              * `<any other python files>`
          * **[versioneer.py](../versioneer.py)**       <- _must be here in the top level folder [^1]_
          * **[setup.py](../setup.py)**            <- _must be here in the top level folder_ [^2]
          * **[setup.cfg](../setup.cfg)**           <- _must be here in the top level folder_ [^2] 
          * **[requirements.txt](../requirements.txt)**    <- _must be here in the top level folder_ [^3]
          * **[MANIFEST.in](../MANIFEST.in)**         <- _Not strictly required_
        
        [^1]: Unlike `versioneer.py`, `_version.py` does not have to be on the top level folder, which I prefer so it does not clutter the project and can be more easily accessed in the project. setup.cfg should be changed so that the file path of the src/\<module\>, where `_version.py` will be kept is given
        [^2]: Some applications use only one- a setup.py or setup.cfg, but versioneer prefers both.
        [^3]: Can be autogenerated by PyCharm. Will not be blank as must have versioneer at least.
        
        
        ## Project Structure References
        1. https://github.com/yngvem/python-project-structure
        1. https://github.com/johnthagen/python-blueprint#project-structure 
        
        
        ## Usage
        Run `src/YerrabelliFlask/main.py` with python
        
        
        ## Tested OS and History Details  
        * Tested primarily on/with
          * Mac OS X (10.14 Mojave on a 2018 Macbook pro)
          * python 3.6-3.9 derived from anaconda 
          * PyCharm  
        
        
        ## License
        See [LICENSE.txt](LICENSE.txt)
        
        
        ## Author & Contact info
        Rahul Yerrabelli  
        
        | Service        	| URL                                                                                                	|
        |----------------	|----------------------------------------------------------------------------------------------------	|
        | GitHub         	| https://github.com/ryerrabelli/                                                                    	|
        | ORCID          	| https://orcid.org/0000-0002-7670-9601                                                              	|
        | Google Scholar 	| https://scholar.google.com/citations?user=pEvGRdkAAAAJ                                             	|
        | LinkedIn       	| https://www.linkedin.com/in/ryerrabelli                                                            	|
        | Email          	| ![Email addresses as an image to prevent spam](email-address-image.png "Email Addresses as Image") 	|
        
        Table generated using https://www.tablesgenerator.com/markdown_tables
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Environment :: MacOS X
Classifier: Natural Language :: English
Requires-Python: >=3.6
Description-Content-Type: text/markdown
