Skip to content

improved Importations #1

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 11 commits into from
Jul 20, 2022
Merged

Conversation

keosariel
Copy link
Contributor

The importation:

from thepeer import main

thepeer_instance = main.Thepeer("PRIVATE_KEY")

Doesn't look great by convention. With my modifications, the importation looks like:

from thepeer import Thepeer

thepeer_instance = Thepeer("PRIVATE_KEY")

And I also updated the tests and the readme to match the new build. I also removed the test folder, instead of:

thepeer/tests/

#  its now
...
thepeer/
tests/
run_tests.sh

and I also added a one liner script to run tests

@E-wave112
Copy link
Collaborator

E-wave112 commented Jul 14, 2022

The importation:

from thepeer import main

thepeer_instance = main.Thepeer("PRIVATE_KEY")

Doesn't look great by convention. With my modifications, the importation looks like:

from thepeer import Thepeer

thepeer_instance = Thepeer("PRIVATE_KEY")

And I also updated the tests and the readme to match the new build. I also removed the test folder, instead of:

thepeer/tests/

#  its now
...
thepeer/
tests/
run_tests.sh

and I also added a one liner script to run tests

The importation:

from thepeer import main

thepeer_instance = main.Thepeer("PRIVATE_KEY")

Doesn't look great by convention. With my modifications, the importation looks like:

from thepeer import Thepeer

thepeer_instance = Thepeer("PRIVATE_KEY")

And I also updated the tests and the readme to match the new build. I also removed the test folder, instead of:

thepeer/tests/

#  its now
...
thepeer/
tests/
run_tests.sh

and I also added a one liner script to run tests

Noted @keosariel great work!

Here a few things to note so you can update the PR accordingly:

  • the exceptions/error types should be kept decoupled
  • the constants.py file should be kept in the utils directory
  • .DS_STORE shouldn't be in version control
  • you could also squash all your commits into one final commit

Thank you!

@E-wave112 E-wave112 added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 14, 2022
@keosariel keosariel force-pushed the keosariel-contrib branch from 5d81e8c to 2f0716a Compare July 15, 2022 09:24
@keosariel keosariel changed the base branch from main to dev July 15, 2022 10:08
@E-wave112 E-wave112 merged commit 38a3328 into thepeerstack:dev Jul 20, 2022
E-wave112 added a commit that referenced this pull request Jul 20, 2022
* improved Importations (#1)

* changed test directory

* improved exception importation

* improved importation

* improved importation

* fixed importation

* added test script

* moved constants

* moved  back

* add .db_store to .gitignore

* decoupled exceptions

* removed .db_store

Co-authored-by: kenneth gabriel <keosariel@icloud.com>

* upgraded to v0.0.4

Co-authored-by: keosariel <31022243+keosariel@users.noreply.github.com>
Co-authored-by: kenneth gabriel <keosariel@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants