@@ -29,49 +29,6 @@ GITHUB_PR_NUMBER=<pull_request_number> \
29
29
codecov
30
30
```
31
31
32
- ## Setting up Local Environment using Pipenv
33
-
34
- To get started, follow these steps:
35
-
36
- 1 . Clone the repository:
37
-
38
- ``` bash
39
- git clone < repository_url>
40
- ```
41
-
42
- 2. Navigate to the cloned repository:
43
-
44
- ` ` ` bash
45
- cd < repository_directory>
46
- ` ` `
47
-
48
- 3. create ` .env` :
49
-
50
- ` ` ` bash
51
- echo " PIPENV_VENV_IN_PROJECT=1" >> .env
52
- ` ` `
53
-
54
- 4. Build the project:
55
-
56
- ` ` ` bash
57
- make all
58
- ` ` `
59
-
60
- 5. ** Export the required environment variables** :
61
-
62
- ` ` ` bash
63
- export GITHUB_REPOSITORY=< repository_name>
64
- export COVERAGE_PATH=< path_to_coverage_report>
65
- export GITHUB_TOKEN=< github_token>
66
- export GITHUB_PR_NUMBER=< pull_request_number>
67
- ` ` `
68
-
69
- 6. ** Run the action** :
70
-
71
- ` ` ` bash
72
- make run
73
- ` ` `
74
-
75
32
## Required Environment Variables
76
33
77
34
- ` GITHUB_REPOSITORY ` : The name of the GitHub repository where the action is running.
@@ -98,52 +55,48 @@ Note: Either `GITHUB_PR_NUMBER` or `GITHUB_REF` is required. `GITHUB_PR_NUMBER`
98
55
- ` COVERAGE_REPORT_URL ` : URL of the full coverage report to mention in the comment.
99
56
- ` DEBUG ` : Whether to enable debug mode. Default is False.
100
57
101
- That' s it! You have successfully cloned the repository and built the project.
102
-
103
- ## Custom Installation
58
+ ## Setting up Local Environment using Pipenv
104
59
105
- 1. Install Python: Make sure you have Python installed on your system.
106
- You can download and install Python from the official Python website.
60
+ To get started, follow these steps:
107
61
108
- 2. Install Pipenv: Pipenv is a package manager that combines pip and virtualenv.
109
- You can install Pipenv using pip, the Python package installer.
110
- Open your terminal or command prompt and run the following command:
62
+ 1 . Clone the repository:
111
63
112
64
``` bash
113
- pip install pipenv
65
+ git clone < repository_url >
114
66
```
115
67
116
- 3. Install project dependencies:
117
- To install the project dependencies specified in the Pipfile, run the following command:
68
+ 2. Navigate to the cloned repository:
118
69
119
70
` ` ` bash
120
- pipenv install --dev
71
+ cd < repository_directory >
121
72
` ` `
122
73
123
- 4. Activate the virtual environment:
124
- To activate the virtual environment created by Pipenv, run the following command:
74
+ 3. create ` .env` :
125
75
126
76
` ` ` bash
127
- pipenv shell
77
+ echo " PIPENV_VENV_IN_PROJECT=1 " >> .env
128
78
` ` `
129
79
130
- 5. Run your project:
131
- You can now run your project using the activated virtual environment.
132
- For example, if your project has a run.py file, you can run it using the following command:
80
+ 4. Build the project:
133
81
134
82
` ` ` bash
135
- python run.py
83
+ make all
136
84
` ` `
137
85
138
- 6. Install pre-commit hooks: To set up pre-commit hooks for your project, run the following command :
86
+ 5. ** Export the required environment variables ** :
139
87
140
88
` ` ` bash
141
- pipenv run pre-commit install
89
+ export GITHUB_REPOSITORY=< repository_name>
90
+ export COVERAGE_PATH=< path_to_coverage_report>
91
+ export GITHUB_TOKEN=< github_token>
92
+ export GITHUB_PR_NUMBER=< pull_request_number>
142
93
` ` `
143
94
144
- This will install and configure pre-commit hooks that will run before each commit to enforce code quality and style standards.
95
+ 6. ** Run the action ** :
145
96
146
- That' s it! You have successfully set up your local environment using Pipenv.
97
+ ` ` ` bash
98
+ make run
99
+ ` ` `
147
100
148
101
---
149
102
> ** NOTE:**
0 commit comments