-
Notifications
You must be signed in to change notification settings - Fork 8
Add developer guide #5
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
Conversation
…tion is successful
DEVGUIDE.md
Outdated
|
||
## How to package your project | ||
|
||
Let's package our project in the same virtual environment . Add necessary files defined in this [tutorial](https://packaging.python.org/) to `locustenv` folder and install `setuptools` and `wheel` to your virtualenv with `pip install`. Add following line yo your `setup.py` file in the `setuptools.setup() object`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
setuptools
and wheel
are part of Python standard library ie. installed by default. Please remove sentence about installing them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wheel
needs to be installed
DEVGUIDE.md
Outdated
``` | ||
|
||
|
||
Next let's run the robot test case to make sure that it works. Copy `test.robot` and `locustfile.py` files to `packagenv/` folder, make the following changes to the variables in `test.robot`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the copying of files need a bit clarification because I was confused about why are we copying locusthandler's code since we have already installed it in this place. Maybe something like: "let's make our Locust tests and Robot Framework tests that run them available in our environment." Or something
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Committed a change for this
…packaging, fix typos
DEVGUIDE.md
Outdated
|
||
``` | ||
pip install wheel | ||
python setup.py sdist bdist_wheel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we don't need sdist in this command, it creates a tar.gz which in the age of wheel is redundant
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Committed a change for this
lgtm, outstanding work |
Developer guides how to write your own handler. The README has link to the developer guide.