Skip to content

Commit f6cdf8b

Browse files
committed
added deploy logic to page, if manual method is required
1 parent e4ac3cb commit f6cdf8b

File tree

2 files changed

+88
-4
lines changed

2 files changed

+88
-4
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,10 +216,52 @@ algorithm.init({"data": "https://i.imgur.com/bXdORXl.jpeg"})
216216

217217
```
218218

219-
### Readme publishing
219+
## Readme publishing
220220
To compile the template readme, please check out [embedme](https://github.com/zakhenry/embedme) utility
221221
and run the following:
222222
```commandline
223223
npm install -g npx
224224
npx embedme --stdout README_template.md > README.md
225-
```
225+
```
226+
227+
## To publish a new version
228+
Publishing should be automatic on new releases, but if you wish to publish manually this is the process
229+
first make sure to update the version in [setup.py](setup.py)
230+
Then go through the following
231+
Then, install these python dependencies
232+
```commandline
233+
pip install wheel==0.33
234+
pip install setuptools==41.6
235+
pip install twine==1.15
236+
```
237+
238+
Setup your ~/.pypirc file:
239+
```commandline
240+
index-servers =
241+
pypi
242+
pypitest
243+
244+
[pypi]
245+
repository: https://upload.pypi.org/legacy/
246+
username: algorithmia
247+
password: {{...}}
248+
249+
[pypitest]
250+
repository: https://test.pypi.org/legacy/
251+
username: algorithmia
252+
password: {{...}}
253+
```
254+
The passwords (and the pypirc file itself) can be found in our devtools service
255+
Make sure to update your setup.py with the new version before compiling.
256+
Also make sure that this is created on Linux and not any other platform.
257+
Compile via setup.py:
258+
```commandline
259+
python setup.py sdist bdist_wheel --universal
260+
python -m twine upload -r pypitest dist/*
261+
262+
```
263+
Verify that it works on pytest, then:
264+
```commandline
265+
python -m twine upload -r pypi dist/*
266+
```
267+
and you're done :)

README_template.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,52 @@ Check out these examples to help you get started:
5555
```python
5656
```
5757

58-
### Readme publishing
58+
## Readme publishing
5959
To compile the template readme, please check out [embedme](https://github.com/zakhenry/embedme) utility
6060
and run the following:
6161
```commandline
6262
npm install -g npx
6363
npx embedme --stdout README_template.md > README.md
64-
```
64+
```
65+
66+
## To publish a new version
67+
Publishing should be automatic on new releases, but if you wish to publish manually this is the process
68+
first make sure to update the version in [setup.py](setup.py)
69+
Then go through the following
70+
Then, install these python dependencies
71+
```commandline
72+
pip install wheel==0.33
73+
pip install setuptools==41.6
74+
pip install twine==1.15
75+
```
76+
77+
Setup your ~/.pypirc file:
78+
```commandline
79+
index-servers =
80+
pypi
81+
pypitest
82+
83+
[pypi]
84+
repository: https://upload.pypi.org/legacy/
85+
username: algorithmia
86+
password: {{...}}
87+
88+
[pypitest]
89+
repository: https://test.pypi.org/legacy/
90+
username: algorithmia
91+
password: {{...}}
92+
```
93+
The passwords (and the pypirc file itself) can be found in our devtools service
94+
Make sure to update your setup.py with the new version before compiling.
95+
Also make sure that this is created on Linux and not any other platform.
96+
Compile via setup.py:
97+
```commandline
98+
python setup.py sdist bdist_wheel --universal
99+
python -m twine upload -r pypitest dist/*
100+
101+
```
102+
Verify that it works on pytest, then:
103+
```commandline
104+
python -m twine upload -r pypi dist/*
105+
```
106+
and you're done :)

0 commit comments

Comments
 (0)