Skip to content
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

Improve pypesa directory structure #6

Open
SentinelWarren opened this issue Nov 3, 2021 · 1 comment
Open

Improve pypesa directory structure #6

SentinelWarren opened this issue Nov 3, 2021 · 1 comment

Comments

@SentinelWarren
Copy link
Contributor

SentinelWarren commented Nov 3, 2021

Greetings @Kalebu , so this just a suggestion on the package structure improvement. Suggestion list goes as follows;

  • Use __init__.py to only Import key classes | methods from modules directly into the package namespace. i.e the folder structure could then be;
pypesa/
__init__.py
mpesa.py
mpesa_execptions.py
service_urls.py
  • __init__.py could also include other important parameters like, version, author, release date, doc-string with a decent sample usage etc etc.
  • Add a tests folder with the following structure;
tests/
__init__.py
test_pypesa.py

Note, tests/__init__.py can/should be left empty.

  • Any other structural improvements that i haven't listed/noticed yet.

So to sum up, i think i can working on this if you think it might be a good idea. Also, i think there other code related improvements suggestion(mostly on the OOD), that i will definitely create their own separate issues.

@Kalebu
Copy link
Collaborator

Kalebu commented Nov 3, 2021

Hi Warren

Thanks for taking your time putting all together

I think its great idea, you can proceed with the changes

  • update the documentation for every change you make

Let me incase of anything

Best regards
Kalebu

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

No branches or pull requests

2 participants