Skip to content

PEP8 compliance updates and updates to __init__.py files [enhancement] #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 18, 2017
Merged

Conversation

IanDoarn
Copy link
Contributor

@IanDoarn IanDoarn commented Aug 17, 2017

  • Added Contributors.md

  • Updates all init.py files:

    • Optimized imports
    • added all to list all modules in packages
  • Updated main init.py

    • Added all contibutors
    • updated docstring
  • Update main init.py:

    • Added all contibutors
    • Added proper docstrings to top of files
    • Optimized imports
    • Added version, author, maintainers, contributors
    • Added all variable to list all modules in package
  • Brought all files in sorting module to PEP8 compliance:

    • Added proper docstrings to top of files
    • Added proper docstrings to methods
    • removed camel casing from variable and method names, they are not commonly used in python with the preferred convention being snake_case

When users are using this from the command line, after importing
the module or its packages they can call help() on the methods or packages that
have been imported!

Example:

import pygorithm

help(pygorithm)

Help on package pygorithm:

NAME
    pygorithm - Pygorithm

DESCRIPTION
    A Python module to learn all the major algorithms on the go!
    Purely for educational purposes

    If you have found my software to be of any use to you,
    do consider helping me pay my internet bills.
    This would encourage me to create many such softwares :)

    PayPal -> https://paypal.me/omkarpathak27
    INR - > https://www.instamojo.com/@omkarpathak/

PACKAGE CONTENTS
    data_structures (package)
    fibonacci (package)
    math (package)
    searching (package)
    sorting (package)

DATA
    __all__ = ['data_structures', 'fibonacci', 'math', 'searching', 'sorti...
    __contributors__ = ['Mohamed Kiouaz', 'Ashutosh Gupta']
    __maintainers__ = ['Omkar Pathak']

VERSION
    1.0.0

AUTHOR
    Omkar Pathak

FILE
    c:\users\doarni\dev\pygorithm\pygorithm\__init__.py

IanDoarn added 2 commits August 17, 2017 12:56
…g this from the command line, after importing

the module or its packages they can call help() on the methods or packages.

Update modular level __init__.py:
 - Added proper docstrings to top of files
 - optimized imports
 - added __version__, __author__, __maintainers__, __contributors__
 - Added __all__ variable to list all modules in package

Brought all files in sorting module to PEP8 compliance:
 - Added proper docstrings to top of files
 - Added proper docstrings to methods
 - removed camel casing from variable and method names, they are not PEP8 compliant

Fixed sorting module __init__.py:
  - Added proper docstrings to top of file
  - Added __all__ variable to list all modules in package
  - optimized imports

Example:
```
import pygorithm

help(pygorithm)

Help on package pygorithm:

NAME
    pygorithm - Pygorithm

DESCRIPTION
    A Python module to learn all the major algorithms on the go!
    Purely for educational purposes

    If you have found my software to be of any use to you,
    do consider helping me pay my internet bills.
    This would encourage me to create many such softwares :)

    PayPal -> https://paypal.me/omkarpathak27
    INR - > https://www.instamojo.com/@omkarpathak/

PACKAGE CONTENTS
    data_structures (package)
    fibonacci (package)
    math (package)
    searching (package)
    sorting (package)

DATA
    __all__ = ['data_structures', 'fibonacci', 'math', 'searching', 'sorti...
    __contributors__ = ['Mohamed Kiouaz', 'Ashutosh Gupta']
    __maintainers__ = ['Omkar Pathak']

VERSION
    1.0.0

AUTHOR
    Omkar Pathak

FILE
    c:\users\doarni\dev\pygorithm\pygorithm\__init__.py
```
     - Optimized imports
     - added __all__ to list all modules in packages
 - Updated main __init__.py
     - Added all contibutors
     - updated docstring

 - Added Contributors.md
@IanDoarn IanDoarn changed the title PEP8 Compliance Updates and to __init__.py files and PEP8 compliance updates and updates to __init__.py files Aug 17, 2017
@IanDoarn IanDoarn changed the title PEP8 compliance updates and updates to __init__.py files [enhancement] PEP8 compliance updates and updates to __init__.py files Aug 17, 2017
@IanDoarn IanDoarn changed the title [enhancement] PEP8 compliance updates and updates to __init__.py files PEP8 compliance updates and updates to __init__.py files [enhancement] Aug 17, 2017
@OmkarPathak OmkarPathak merged commit 4b88db8 into OmkarPathak:master Aug 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants