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

[docs] Added instruction for using virtualenv #177

Merged

Conversation

youhaveme9
Copy link
Contributor

Checklist

  • I have read the OpenWISP Contributing Guidelines.
  • I have manually tested the changes proposed in this pull request.
  • I have written new test cases for new code and/or updated existing tests for changes to existing code.
  • I have updated the documentation.

Reference to Existing Issue

Closes #170

Description of Changes

Recommend using Python Virtualenv in development instructions.

Comment on lines 19 to 33
Install your forked repo:
Create and activate virtual environment in your forked repo:

.. code-block:: shell

git clone git://github.com/<your_fork>/openwisp-ipam
cd openwisp-ipam/
virtualenv venv
source venv/bin/activate

Install your forked repo:

.. code-block:: shell

pip install -e .

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you make these steps consistent with what we have in openwisp-controller?

@youhaveme9
Copy link
Contributor Author

Updated the docs as required

@youhaveme9 youhaveme9 requested a review from pandafy December 20, 2024 05:41
@youhaveme9 youhaveme9 force-pushed the issues/170-recommend-virtualenv-in-docs branch from 579a35b to c0a393f Compare December 20, 2024 07:25
@pandafy pandafy merged commit fa636e3 into openwisp:master Dec 20, 2024
12 checks passed
pandafy pushed a commit that referenced this pull request Dec 20, 2024
@youhaveme9 youhaveme9 deleted the issues/170-recommend-virtualenv-in-docs branch December 20, 2024 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

[docs] Recommend virtualenv in development instructions
2 participants