Skip to content

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

Merged
merged 36 commits into from
Jul 9, 2020
Merged

Add developer guide #5

merged 36 commits into from
Jul 9, 2020

Conversation

FummiTaksi
Copy link
Contributor

Developer guides how to write your own handler. The README has link to the developer guide.

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`:
Copy link
Contributor

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.

Copy link
Contributor Author

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`:
Copy link
Contributor

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

Copy link
Contributor Author

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

DEVGUIDE.md Outdated

```
pip install wheel
python setup.py sdist bdist_wheel
Copy link
Contributor

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

Copy link
Contributor Author

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

@Tattoo
Copy link
Contributor

Tattoo commented Jul 9, 2020

lgtm, outstanding work

@Tattoo Tattoo merged commit 641559a into master Jul 9, 2020
@FummiTaksi FummiTaksi deleted the developer_guide branch July 13, 2020 09:19
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

Successfully merging this pull request may close these issues.

2 participants