Skip to content

Commit

Permalink
Fix isort config + README
Browse files Browse the repository at this point in the history
  • Loading branch information
Uğur Özyılmazel committed Aug 30, 2020
1 parent 58c0f02 commit 810aee8
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .isort.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ use_parentheses = true
include_trailing_comma = true
quiet = true
force_grid_wrap = 0
known_flask = flask
sections = FUTURE,STDLIB,FLASK,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,68 @@ rake upload:main # Upload package to main distro (release)
rake upload:test # Upload package to test distro
```

You need `ruby` to run rake tasks. Rake tasks are just helper functions for
automation. You don’t need to install anything to proceed. If you are on
macOS, you’ll already have ruby installed.

If you are on Ubuntu:

```bash
# install ruby on Ubuntu
$ sudo apt-get update -y
$ sudo apt-get install -y ruby-full
```

You need `bumpversion` to manage package versioning. If you are on
macOS:

```bash
$ brew install bumpversion
```

If you are on Ubuntu:

```bash
# install bumpversion on Ubuntu
$ sudo apt-get update -y
$ sudo apt-get -y bumpversion
```

To install and test package locally, just call `rake` or `rake install`.
Tests are available under `tests/` folder. Run `rake test` to run tests.

To continue without `ruby` or `rake`:

- Install package locally: `pip install -e .[development]`
- Build package: `python setup.py sdist bdist_wheel`
- Install `bumpversion`: `pip install bumpversion`

For uploading package to **pypi** registry you need to install:

```bash
$ pip install -U wheel setuptools
```

You need to put pypi credentials to `~/.pypirc`:

[distutils]
index-servers=
pypi-promptapi
testpypi-promptapi

[pypi-promptapi]
repository = https://upload.pypi.org/legacy/
username: __token__
password: TOKEN

[testpypi-promptapi]
repository: https://test.pypi.org/legacy/
username: __token__
password: TOKEN

- Upload to main registry: `twine upload --repository pypi-promptapi dist/*`
- Upload to test repository: `twine upload --repository testpypi-promptapi dist/*`

---

## License
Expand Down
12 changes: 12 additions & 0 deletions requirements-lint.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
flake8==3.8.3
flake8-bandit==2.1.2
flake8-blind-except==0.1.1
flake8-bugbear==20.1.4
flake8-builtins==1.5.3
flake8-polyfill==1.0.2
flake8-print==3.1.4
flake8-quotes==3.2.0
flake8-string-format==0.3.0
isort==4.3.21
pylint==2.4.2
black==20.8b1

0 comments on commit 810aee8

Please sign in to comment.