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

What is contributor workflow #93

Open
ziloka opened this issue Aug 22, 2022 · 7 comments
Open

What is contributor workflow #93

ziloka opened this issue Aug 22, 2022 · 7 comments
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@ziloka
Copy link

ziloka commented Aug 22, 2022

I'm not very experienced with python and I just did my first PR for this project. What is your developer workflow?
I usually just write my code, and run pip install . and test it.

@ziloka
Copy link
Author

ziloka commented Aug 22, 2022

This is related to #82

@bluet
Copy link
Owner

bluet commented Aug 23, 2022

hi @ziloka , basically just write code, test it, and ensure the result passes code quality checks and all the tests.

When a PR is created, some auto testing process will start, and other developers will help with code review.

Make sure you have all the information needed in the PR description section, including what problem(s) you're solving, a few sentences about how you did it, and what other things should be noted or aware of.

Just try to communicate, and everything will be all fine. :-)

I'd be nice to have you joined! 🚀

@ziloka
Copy link
Author

ziloka commented Aug 23, 2022

Thank you

@bluet bluet added documentation Improvements or additions to documentation question Further information is requested labels Aug 23, 2022
@hms5232
Copy link

hms5232 commented Aug 24, 2022

Maybe we can remove requirements.txt and other files not necessary after (fully) use Poetry. This prevent contributors from taking wrong tool or outdated dependency.

For example, I notice the requirements.txt and I don't know Poetry. That will make me use pip install -r requirements.txt to install dependencies but those may outdated.

To reach this, update README (#85 ) and build a workflow depend on Poetry is indispensable.

@bluet
Copy link
Owner

bluet commented Aug 24, 2022

@hms5232 sure why not. It'd be awesome.

@ziloka
Copy link
Author

ziloka commented Nov 12, 2023

I use this command in the root directory to test whatever I want.

poetry run python -m proxybroker [args.. options.. etc]

eg

poetry run python -m proxybroker find --types HTTP HTTPS --lvl High --countries US --strict -l 10

Sometimes when I want to more information to debug I'll run it with the logging on debug

 poetry run python -m proxybroker --log DEBUG find --types HTTP HTTPS SOCKS4 SOCKS5 -l 10

what command do you run to test the cli?

@ziloka
Copy link
Author

ziloka commented Nov 13, 2023

Here use pyenv, in combination of poetry

pyenv local 3.11.6
poetry install
# run whatever command
poetry run python -m proxybroker find --types HTTP HTTPS SOCKS4 SOCKS5 -l 10

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 question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants