Document development environment setup - Githubissues

rapid7 / nexpose-client-python

DEPRECATED : Rapid7 Nexpose API client library written in Python

https://www.rapid7.com/

BSD 3-Clause "New" or "Revised" License

25 stars 20 forks source link

Document development environment setup #1

Open gschneider-r7 opened 7 years ago

gschneider-r7 commented 7 years ago

We need to document how to setup a development environment so anyone can contribute easily.

Desired:

[ ] Be tool-agnostic, i.e. don't pick a specific IDE; Stick to text editors - perhaps suggest some tools and configurations if we want to provide options.
[x] Linux instructions to setup python environment (virtualenv, dependencies, etc)
[x] Mac OS X instructions to setup python environment (virtualenv, dependencies, etc)
[x] Windows instructions to setup python environment (vitualenv possible? dependencies, etc)

Additional instructions for the following tools would also be nice to have:

[ ] Sublime Text
[ ] Atom
[ ] Visual Studio Code
[ ] PyCharm
[ ] WingIDE
[ ] PyScripter
Others?

dhaynespls commented 7 years ago

Just reporting --

When installing the lxml package the following dependencies are needed:

https://stackoverflow.com/a/15761014

derpadoo commented 7 years ago

How do you want us to add Wiki pages? Not seeing the Edit page button. Wrote one for "Getting-started-on-Ubuntu.md"

gschneider-r7 commented 7 years ago

I should be able to get the wiki permissions fixed later today, sorry about that.

gschneider-r7 commented 7 years ago

The wiki should be publicly editable now.

gschneider-r7 commented 7 years ago

I created a general development environment guide here: https://github.com/rapid7/nexpose-client-python/wiki/Development-Environment-Setup