Merge pull request #91 from CenterForOpenScience/release-on-pypi

Release on pypi

Author: BenitoMatischen

README.md

@@ -4,29 +4,38 @@ This is a CLI tool for exporting research project data and files from the [OSF w
 
 ## Development Setup
 
+### Virtual Environment
+
+1. Clone this repository onto your local machine.
+2. Create a virtual environment to install dependencies. For virtualenv this is done with ``virtualenv <myenvname>``. Make sure your virtual environment is setup to use Python 3.12 or above (e.g., ``virtualenv <myenvname> --python="/usr/bin/python3.12"`` on Linux.)
+3. From local Git repo: Activate your virtual environment and run ``pip install -e osfexport`` to install this repository as a modifiable package. Then install other requirements separately via `pip install -r requirements.txt`.
+4. On the OSF website, create or log in to your account.  Set up a personal access token (PAT) by going into your account settings, select `Personal access tokens` in the left side menu, and clicking `Create token`. You should give the token a name that helps you remember why you made it, like "PDF export", and choose the `osf.full_read` scope - this allows this token to read all public and private projects on your account. You can delete this token once you have finished exporting your projects.
+
 ### Docker
 
 You can setup a Docker container with this tool installed as a Python package:
 
 1. [Install and setup Docker and Docker Desktop on your local machine](https://docs.docker.com/desktop/).
 2. Clone this repository onto your local machine.
-3. On the OSF website, create or log in to your account.  Set up a personal access token (PAT) by going into your account settings, selecting "Personal access tokens" in the left side menu, and clicking "Create token". You should give the token a name that helps you remember why you made it, like "PDF export", and choose the "osf.full_read" scope - this allows this token to read all public and private projects on your account. You can delete this token once you have finished exporting your projects.
+3. On the OSF website, create or log in to your account.  Set up a personal access token (PAT) by going into your account settings, select `Personal access tokens` in the left side menu, and clicking `Create token`. You should give the token a name that helps you remember why you made it, like "PDF export", and choose the `osf.full_read` scope - this allows this token to read all public and private projects on your account. You can delete this token once you have finished exporting your projects.
 4. Create a `.env` file and add your personal access token to it (see `.env.template`.)
 5. In the root of this repository, run `docker compose up --build -d` to setup a container.
 6. Use `docker compose exec -it cli <commands>` to run CLI tool commands (e.g. `export-projects`) or run unit tests (i.e. `python -m unittest`.)
 
-### Virtual Environment
+## Installation
 
-You could also setup a Python virtual environment (e.g. using virtualenv):
+### From PyPI: releases 0.1.4 and onwards
 
-1. Clone this repository onto your local machine.
-2. Create a virtual environment, e.g., ``virtualenv myenv --python='"/usr/bin/python3.12"'``. Make sure your virtual environment is setup to use Python 3.12 or above.
-3. From local Git repo: Activate your virtual environment and run ``pip install -e osfexport` to install this repository as a modifiable package. Then install other requirements separately via `pip install -r requirements.txt`.
-4. On the OSF website, create or log in to your account.  Set up a personal access token (PAT) by going into your account settings, selecting "Personal access tokens" in the left side menu, and clicking "Create token". You should give the token a name that helps you remember why you made it, like "PDF export", and choose the "osf.full_read" scope - this allows this token to read all public and private projects on your account. You can delete this token once you have finished exporting your projects.
+Activate your virtual environment, for virtualenv this is done by:
 
-## Installation
+- `source <myenvname>/bin/activate` on Linux
+- `<myenvname>\Scripts\activate` on Windows/Mac
+
+Next, run `python -m pip install osfexport`. This will download and install this package and other dependencies from the PyPI index.
+
+### From TestPyPi: releases before 0.1.4
 
-From TestPyPI: Activate your virtual environment and run `#python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple osfexport`. This will download the packages needed from the PyPI index and the packaged version of this CLI tool on the TestPyPI index.
+Activate your virtual environment and run `python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple osfexport`. This will download the packages needed from the PyPI index and the packaged version of this CLI tool on the TestPyPI index.
 
 ## Usage
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "osfexport"
-version = "0.1.3"
+version = "0.1.4"
 authors = [
   { name="Benito Matischen", email="[email protected]" },
   { name="Ramiro Bravo", email="[email protected]" },