@@ -28,8 +28,9 @@ and ease of maintenance.
28
28
- [ Changes from Original] ( #changes-from-original )
29
29
- [ Requirements] ( #requirements )
30
30
- [ Installation] ( #installation )
31
- - [ From Source ] ( #from-source )
31
+ - [ Using PyPI ] ( #using-pypi )
32
32
- [ Using ` setup.py ` ] ( #using-setuppy )
33
+ - [ From Source] ( #from-source )
33
34
- [ Usage] ( #usage )
34
35
- [ Interactive Mode] ( #interactive-mode )
35
36
- [ Non-Interactive Mode] ( #non-interactive-mode )
@@ -124,62 +125,71 @@ to the parent project:
124
125
125
126
## Installation
126
127
127
- ### From Source
128
+ ### Using PyPI
128
129
129
- 1. **Clone the Repository **:
130
+ 1. **Install Using pip **:
130
131
131
132
```bash
132
- git clone https://github.com/tomice/git-py-stats.git
133
- cd git-py-stats
133
+ pip install git-py-stats
134
134
```
135
135
136
- 2. **Install the Package**:
136
+ That' s it! You can now use ` git-py-stats` anywhere on your system
137
+ while inside of a git repo!
137
138
138
- You can install the package directly from PyPI.
139
- This allows you to run `git-py-stats` from anywhere on your system.
139
+ If you experience conflicts with other packages,
140
+ try using [ ` venv ` ](https://docs.python.org/3/library/venv.html)
140
141
141
- ```bash
142
- pip install git-py-stats
143
- ```
142
+ # ## Using `setup.py`
144
143
145
- Or you can run it locally without `pip` by doing the following
146
- while inside the `git-py-stats` repo from Step 1:
144
+ If you prefer using ` setup.py` directly:
145
+
146
+ 1. ** Clone the Repository** :
147
147
148
148
` ` ` bash
149
- export PYTHONPATH=$(pwd):$PYTHONPATH
149
+ git clone https://github.com/tomice/git-py-stats.git
150
+ cd git-py-stats
150
151
` ` `
151
152
152
- 3. **Verify the Installation**:
153
-
154
- While inside of a valid git repo, type the following:
153
+ 2. ** Install the Package** :
155
154
156
155
` ` ` bash
157
- git-py-stats --help
156
+ python setup.py install
158
157
` ` `
159
158
160
- If you decided to use the `PYTHONPATH` method, commands will need
161
- to be done in the following manner:
159
+ That' s it! You can now use `git-py-stats` anywhere on your system
160
+ while inside of a git repo! If you don' t have admin permissions,
161
+ you can use the ` --user` flag at the end of the command to install
162
+ this locally.
163
+
164
+ # ## From Source
165
+
166
+ 1. ** Clone the Repository** :
162
167
163
168
` ` ` bash
164
- python -m git_py_stats.main --help
169
+ git clone https://github.com/tomice/git-py-stats.git
170
+ cd git-py-stats
165
171
` ` `
166
172
167
- ### Using `setup.py`
168
-
169
- If you prefer using `setup.py` directly:
173
+ 2. ** Set PYTHONPATH** :
170
174
171
- 1. **Install the Package** :
175
+ Set the root of ` git-py-stats ` to be prefixed to your ` PYTHONPATH ` :
172
176
173
177
` ` ` bash
174
- python setup.py install
178
+ export PYTHONPATH= $( pwd ) : $PYTHONPATH
175
179
` ` `
176
180
177
- 2. **Verify the Installation**:
181
+ That' s it! You can now use `git-py-stats` anywhere on your system
182
+ while inside of a git repo, albeit with a slight modification.
183
+ Commands will need to be done in the following manner:
178
184
179
185
```bash
180
- git-py-stats --help
186
+ python -m git_py_stats.main --help
181
187
```
182
188
189
+ This will tell Python to run the `git_py_stats.main` module directly.
190
+ This method is usually best for devs who want to help contribute to the
191
+ project without going through the install process a normal end user would.
192
+
183
193
## Usage
184
194
185
195
You can run Git Py Stats in both interactive and non-interactive modes:
0 commit comments