bluet / proxybroker2

The New (auto rotate) Proxy [Finder | Checker | Server]. HTTP(S) & SOCKS :performing_arts:
Apache License 2.0
745 stars 112 forks source link

What is contributor workflow #93

Open ziloka opened 2 years ago

ziloka commented 2 years ago

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 commented 2 years ago

This is related to #82

bluet commented 2 years ago

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! :rocket:

ziloka commented 2 years ago

Thank you

hms5232 commented 2 years ago

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 commented 2 years ago

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

ziloka commented 11 months ago

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 commented 11 months ago

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