Skip to content

Commit 9f68f6b

Browse files
author
Dylan
authored
Update README.rst
1 parent 69f060d commit 9f68f6b

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,28 @@ To use all debugging tools, create new features, or use local data, we can switc
101101
102102
$ bentodev start <account_name> --local
103103
104+
Working on `bentodev`
105+
---------------------
106+
To make changes to `bentodev` please clone the repository, then with a seperate virtual environment, install it as a local dependency.
107+
108+
.. code-block:: bash
109+
110+
$ git clone git@github.com:getbento/bentodev.git
111+
$ mkdir bentodev-local/ && cd bentodev-local && pipenv --three && pipenv shell
112+
$ pipenv install -e ../path/to/cloned/pipenv
113+
114+
This will clone bentodev, create a new virtualenv, and install the local bentodev to that environment.
115+
116+
Then, changes made will be reflected in the running application when using the newly created virtual environment.
117+
118+
TO DEPLOY THOSE CHANGES to the `bentodev PyPi repo <https://pypi.org/project/bentodev/>`_, ensure that the dev dependencies from `bentodev`s Pipfile are installed to a virtual environment or are on your system. Mainly, `setuptools` and `twine` are required for deployment. Bump the version inside: `bentodev/__version__.py`.
119+
120+
Assuming deps and PyPi configuration is complete, run the following to update the repository:
121+
122+
.. code-block:: bash
123+
124+
$ python setup.py upload
125+
104126
User Configuration
105127
==================
106128

0 commit comments

Comments
 (0)