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.

Sign up for GitHub

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

Jump to bottom

Add info about new install scripts #1519

Merged
merged 7 commits into from
Jan 5, 2023
Merged

Add info about new install scripts #1519

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5fee3e7
Add info about new install scripts
charlesbvll Dec 18, 2022
a20589b
Merge branch 'main' into doc_new_install
danieljanes Dec 29, 2022
82a21e0
Merge branch 'main' into doc_new_install
charlesbvll Dec 29, 2022
5c38cba
Merge branch 'main' into doc_new_install
charlesbvll Dec 30, 2022
2a8fae2
Merge branch 'main' into doc_new_install
charlesbvll Dec 30, 2022
9561bee
Merge branch 'main' into doc_new_install
charlesbvll Jan 5, 2023
2249512
Update getting-started-for-contributors.rst
charlesbvll Jan 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions doc/source/getting-started-for-contributors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,22 @@ GitHub::
$ cd flower

Second, create a virtual environment (and activate it). If you chose to use
:code:`pyenv` (with the :code:`pyenv-virtualenv` plugin), you can use the
following convenience script::
:code:`pyenv` (with the :code:`pyenv-virtualenv` plugin) and already have it installed
, you can use the following convenience script (by default it will use :code:`Python 3.7.15`,
but you can change it by providing a specific :code:`<version>`)::

$ ./dev/venv-create.sh
$ ./dev/venv-create.sh <version>

If you don't have :code:`pyenv` installed,
you can use the following script that will install pyenv,
set it up and create the virtual environment (with :code:`Python 3.7.15` by default)::

$ ./dev/setup-defaults.sh <version>

Third, install the Flower package in development mode (think
:code:`pip install -e`) along with all necessary dependencies::

(flower-3.7.15) $ ./dev/bootstrap.sh
(flower-<version>) $ ./dev/bootstrap.sh


Convenience Scripts
Expand All @@ -48,8 +55,8 @@ Create/Delete Virtual Environment

::

$ ./dev/venv-create.sh
$ ./dev/venv-delete.sh
$ ./dev/venv-create.sh <version> # Default is 3.7.15
$ ./dev/venv-delete.sh <version> # Default is 3.7.15

Compile ProtoBuf Definitions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down