Skip to content

Commit

Permalink
Documentation and setup fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Furtado committed Oct 29, 2018
1 parent 65a8483 commit fb17545
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 16 deletions.
4 changes: 4 additions & 0 deletions HISTORY.md
@@ -1,5 +1,9 @@
# History

### 0.1.4 (2018-10-29)

* Documentation fixes.

### 0.1.3 (2018-10-26)

* Documentation fixes.
Expand Down
16 changes: 5 additions & 11 deletions README.md
Expand Up @@ -10,7 +10,7 @@ we can take advantage of all its neat features. PyTerrier is highly inspired by

## Highlight features

- Written in Python 3.7
- Written in Python 3.7
- Favorite conventions over configuration
- Value simple code
- Flexible
Expand Down Expand Up @@ -57,9 +57,9 @@ The `--newapp` option especify the name of you application, the option `--curren
application files in our current directory, without this option the CLI will create a directory with the same name of your application
and create the files in there.

That's it, you done! :metal:
That's it, you done!

By default, the application will run on the port 8000. Just open up your browser and go to http://localhost:8000
By default, the application will run on the port 8000. Just open up your browser and go to http://localhost:8000

To get a full description of the options available in the Pyterrier CLI you can use the `--help` option like so `pyterrier --help` and you should see the output below:

Expand Down Expand Up @@ -105,8 +105,8 @@ app = PyTerrier(port=3000)
@app.get('/sayhello')
def sayhello(self):
return ViewResult('index.html', { 'message': 'Hellooooo!' })
app.run()

app.run()

```

Expand Down Expand Up @@ -281,9 +281,3 @@ Copyright (c) 2017 [Daniel Furtado](https://twitter.com/the8bitcoder). Code rele
## Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.






3 changes: 1 addition & 2 deletions setup.cfg
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.1.3
current_version = 0.1.4
commit = True
tag = True

Expand All @@ -23,4 +23,3 @@ test = pytest

[tool:pytest]
collect_ignore = ['setup.py']

7 changes: 4 additions & 3 deletions setup.py
Expand Up @@ -31,8 +31,9 @@
'Operating System :: MacOS :: MacOS X',
'Operating System :: Unix',
'Operating System :: POSIX',
'Environment :: Web Environment',
],
description="The web framework that favorite conventions over configurations",
description="The simplest web framework you will ever use",
entry_points={
'console_scripts': [
'pyterrier=pyterrier.pyterrier_cli:main',
Expand All @@ -43,7 +44,7 @@
long_description=readme + '\n\n' + history,
long_description_content_type='text/markdown',
include_package_data=True,
keywords='pyterrier',
keywords='pyterrier web webdevelopment rest webframework',
name='pyterrier',
packages=find_packages(include=[
'pyterrier',
Expand All @@ -58,6 +59,6 @@
test_suite='tests',
tests_require=test_requirements,
url='https://github.com/dfurtado/pyterrier',
version='0.1.3',
version='0.1.4',
zip_safe=False,
)

0 comments on commit fb17545

Please sign in to comment.