Skip to content

Commit c04de01

Browse files
author
Jonathan Como
committed
Update build information for pypi
1 parent 15b43b8 commit c04de01

File tree

5 files changed

+24
-3
lines changed

5 files changed

+24
-3
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ __pycache__/
66

77
env/
88
.tox/
9+
10+
build/
11+
dist/

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ snakedev bootstrap install
2424

2525
You could instead alias to `snake`, but remember to `unalias` when you are done developing in order to switch back to the installed version.
2626

27+
Another option would be to run the following whenever you make changes.
28+
29+
```
30+
python setup.py install
31+
```
32+
33+
This will install the `snake` binary to your python distribution and put it on your path.
34+
The downside to this is that its easy to forget to do this each time.
35+
2736
### Running Tests
2837

2938
While developing, you can either run tests for the current environment using `nosetests` or you can run tests against all supported Python versions using `tox`.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ First, install Snake. It is recommended to install it to your system Python inst
1616
Use a local installation if you need a specific version.
1717

1818
```
19-
pip install snake
19+
pip install snaketool
2020
```
2121

2222
## Usage

Snakefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,11 @@ def test():
2929
def all():
3030
"""Run tests for all support distributions"""
3131
sh('tox --skip-missing-interpreters')
32+
33+
34+
@task
35+
def upload():
36+
"""Upload the current version to PyPI"""
37+
sh('rm -rf build dist')
38+
sh('python setup.py sdist bdist_wheel')
39+
sh('twine upload -u jcomo dist/*')

setup.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,14 @@ def run_tests(self):
3030

3131

3232
setup(
33-
name = 'snake',
34-
version = '0.0.1',
33+
name = 'snaketool',
34+
version = '0.1.0',
3535
description = "An easy to use build script utility",
3636
url = 'https://github.com/jcomo/snake',
3737
author = 'Jonathan Como',
3838
author_email = '[email protected]',
3939
packages = find_packages(exclude=['docs', 'tests', 'scripts']),
40+
scripts = ['bin/snake'],
4041
install_requires = [],
4142
tests_require = ['tox'],
4243
cmdclass = {

0 commit comments

Comments
 (0)