Skip to content

Commit

Permalink
Formatting CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanknights authored Oct 23, 2024
1 parent ed8acae commit 1596dbd
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Welcome to Streamlit component template! We appreciate your interest in contributing to our project.

## Setting up pyenv and Intellij Idea
## Setting up pyenv and Intellij IDEA

### 1. Install pyenv

Expand All @@ -16,11 +16,11 @@ $ curl https://pyenv.run | bash
```shell
$ pyenv install <python_version>
```
- python_version - version of python, you can use
- python_version - version of python. To check all available versions (recommended 3.11.4) use:
```shell
$ pyenv install --list
```
to check all available version, recommended 3.11.4


### 3. Creating virtual environment

Expand All @@ -44,11 +44,11 @@ $ pyenv activate <environment_name>
To configure your Python SDK in your project, follow these steps:

1. Open "File" menu.
2. Navigate to "Project Structure."
3. Under "Project," locate "Edit (SDK)."
2. Navigate to "Project Structure".
3. Under "Project," locate "Edit (SDK)".
4. Click on "Add Python SDK" (using the plus button).
5. Select "Virtualenv Environment."
6. Choose "Existing environment."
5. Select "Virtualenv Environment".
6. Choose "Existing environment".
7. Specify the path to your Python environment using <your_pyenv_location>.

## Run locally example
Expand Down Expand Up @@ -82,9 +82,9 @@ $ pip install -e .

### 5. Run python script and frontend

Example for CustomDataframe
**Example for CustomDataframe**

Run python script
Run python script:
```shell
$ streamlit run examples/CustomDataframe/custom_dataframe/example.py
```
Expand All @@ -101,11 +101,11 @@ $ npm run start

### 1. Run example locally

Please check "Run Locally example" section
Please check "Run Locally example" section.

### 2. Run pytest command

Example for CustomDataframe
Example for CustomDataframe:

```shell
$ pytest examples/CustomDataframe/e2e
Expand Down Expand Up @@ -148,5 +148,3 @@ Run:
$ pip install -e .
```
inside template directory.


0 comments on commit 1596dbd

Please sign in to comment.