Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
edited setup and setup config for 0.0.0 release. also included
distribution instructions.
- Loading branch information
1 parent
364e602
commit 8ea41d2
Showing
3 changed files
with
68 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Instructions for distributing `pyglmnet` | ||
|
||
### Prerequisites | ||
Make sure you have the following packages installed locally: | ||
`twine` | ||
|
||
Create a file called `.pypirc` **in the project directory root.** This file is | ||
included in the `.gitignore` file, as it contains sensitive info. The file | ||
generally is stuctured like this: | ||
|
||
``` | ||
[distutils] | ||
index-servers = | ||
pypi | ||
pypitest | ||
[pypi] | ||
repository: https://pypi.python.org/pypi | ||
username: organization-username | ||
password: organization-password | ||
[pypitest] | ||
repository: https://testpypi.python.org/pypi | ||
username: organization-username | ||
password: organization-password | ||
``` | ||
|
||
Obviously, make sure you're using the proper passwords and usernames. | ||
|
||
### Setup | ||
|
||
Update the `setup.py` file as needed with new versions, authors, packages etc. | ||
Then in the root file of the directory, run: | ||
```bash | ||
$ python setup.py sdist bdist_wheel | ||
``` | ||
Which will create the standard distribution files. | ||
|
||
### Registration and uploading | ||
This is where we will now use `twine` and the custom `.pypirc` file in the root | ||
of the project directory. First, register the package to the `pypitest` server. | ||
|
||
```bash | ||
$ twine register -r pypitest --config-file=.pypirc dist/pyglmnet-<verion number>.tar.gz | ||
``` | ||
|
||
Next, upload. | ||
|
||
```bash | ||
$ twine upload -r pypitest --config-file=.pypirc dist/pyglmnet-<version number>.tar.gz | ||
``` | ||
|
||
To make sure the test worked, head over to the [PyPI test page](https://testpypi.python.org/pypi). | ||
You should see `pyglmnet <version number>` near the top of the list (if you head directly over). | ||
|
||
Great, looks like it worked. let's register, upload and release for real! | ||
|
||
```bash | ||
$ twine register -r pypi --config-file=.pypirc dist/pyglmnet-<version number>.tar.gz | ||
``` | ||
Finally, upload! | ||
|
||
```bash | ||
$ twine upload -r pypi --config-file=.pypirc dist/pyglmnet-<version number>.tar.gz | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters