Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

restruct the code to use soroush pacakge #3

Open
wants to merge 41 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
9faa248
change make keyboard to staticmethod
alinik Oct 25, 2018
1b20cb8
packaging
Oct 25, 2018
f5adf78
update username
Oct 25, 2018
096deec
update badges
Oct 25, 2018
1efb25d
Merge remote-tracking branch 'origin/alinik-static-makekeyboard'
Oct 25, 2018
178bd24
Pin requests to latest version 2.20.0
pyup-bot Oct 25, 2018
5dd4350
Pin sseclient-py to latest version 1.7
pyup-bot Oct 25, 2018
95cd739
Update wheel from 0.32.1 to 0.32.2
pyup-bot Oct 25, 2018
c5da55d
Update flake8 from 3.5.0 to 3.6.0
pyup-bot Oct 25, 2018
f44da87
Update pytest from 3.8.1 to 3.9.2
pyup-bot Oct 25, 2018
62cbcc1
update pyup link
Oct 25, 2018
78a1fa1
Bump version: 0.1.0 → 0.2.0
Oct 25, 2018
2850467
remove readme.rst
Oct 25, 2018
439d261
Merge pull request #2 from alinik/pyup-initial-update
alinik Oct 25, 2018
b68ede5
fix docs
Oct 25, 2018
83e8c4f
Bump version: 0.2.0 → 0.2.1
Oct 25, 2018
8da5032
doc fixing
Oct 25, 2018
96d3a63
Bump version: 0.2.1 → 0.2.1
Oct 25, 2018
f0baa2f
Bump version: 0.2.1 → 0.2.1
Oct 25, 2018
057b87d
fix bumpversion issue
Oct 25, 2018
91e4fae
test bump
Oct 25, 2018
d57c5e6
Bump version: 0.2.2 → 0.2.3
Oct 25, 2018
d577d6a
update to new modifications
Oct 25, 2018
88a04c3
Bump version: 0.2.3 → 0.2.4
Oct 25, 2018
0af03d7
Update pytest from 3.9.2 to 3.10.0
pyup-bot Nov 4, 2018
68456e4
Merge pull request #5 from alinik/pyup-update-pytest-3.9.2-to-3.10.0
alinik Nov 5, 2018
fac9e7f
Update requests from 2.20.0 to 2.20.1
pyup-bot Nov 8, 2018
13832b8
Merge pull request #6 from alinik/pyup-update-requests-2.20.0-to-2.20.1
alinik Nov 10, 2018
b4c9d57
Update sphinx from 1.8.1 to 1.8.2
pyup-bot Nov 11, 2018
69f8025
Merge pull request #7 from alinik/pyup-update-sphinx-1.8.1-to-1.8.2
alinik Nov 11, 2018
869e2e2
Update requests from 2.20.1 to 2.21.0
pyup-bot Dec 10, 2018
a563bd9
Update coverage from 4.5.1 to 4.5.3
pyup-bot Mar 10, 2019
f4dfc03
Update pytest from 3.10.0 to 4.4.0
pyup-bot Mar 31, 2019
fa29f0b
Update tox from 3.5.2 to 3.8.6
pyup-bot Apr 3, 2019
e2dbb4c
Update sphinx from 1.8.2 to 2.0.1
pyup-bot Apr 8, 2019
a847ed0
Merge pull request #13 from alinik/pyup-update-requests-2.20.1-to-2.21.0
alinik Apr 9, 2019
c1c814d
Merge pull request #53 from alinik/pyup-update-sphinx-1.8.2-to-2.0.1
alinik Apr 9, 2019
184d9ae
Merge pull request #52 from alinik/pyup-update-tox-3.5.2-to-3.8.6
alinik Apr 9, 2019
6befe4e
Merge pull request #49 from alinik/pyup-update-pytest-3.10.0-to-4.4.0
alinik Apr 9, 2019
2e0dfac
Merge branch 'master' into pyup-update-coverage-4.5.1-to-4.5.3
alinik Apr 9, 2019
07fa69f
Merge pull request #42 from alinik/pyup-update-coverage-4.5.1-to-4.5.3
alinik Apr 9, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# http://editorconfig.org

root = true

[*]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
charset = utf-8
end_of_line = lf

[*.bat]
indent_style = tab
end_of_line = crlf

[LICENSE]
insert_final_newline = false

[Makefile]
indent_style = tab
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
* Soroush Python SDK version:
* Python version:
* Operating System:

### Description

Describe what you were trying to get done.
Tell us what happened, what went wrong, and what you expected to happen.

### What I Did

```
Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.
```
103 changes: 103 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# dotenv
.env

# virtualenv
.venv
venv/
ENV/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.idea/
29 changes: 29 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Config file for automatic testing at travis-ci.org

language: python
python:
- 3.6
- 3.5
- 3.4
- 2.7

# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
install: pip install -U tox-travis

# Command to run tests, e.g. python setup.py test
script: tox

# Assuming you have installed the travis-ci CLI tool, after you
# create the Github repo and add it to Travis, run the
# following command to finish PyPI deployment setup:
# $ travis encrypt --add deploy.password
deploy:
provider: pypi
distributions: sdist bdist_wheel
user: Ali.Nikneshan
password:
secure: PLEASE_REPLACE_ME
on:
tags: true
repo: alinik/soroush_python_sdk
python: 3.6
13 changes: 13 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
=======
Credits
=======

Development Lead
----------------

* Ali Nikneshan <ali@nikneshan.com>

Contributors
------------

None yet. Why not be the first?
128 changes: 128 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
.. highlight:: shell

============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/alinik/soroush_python_sdk/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

Soroush Python SDK could always use more documentation, whether as part of the
official Soroush Python SDK docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/alinik/soroush_python_sdk/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up `soroush_python_sdk` for local development.

1. Fork the `soroush_python_sdk` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/soroush_python_sdk.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv soroush_python_sdk
$ cd soroush_python_sdk/
$ python setup.py develop

4. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

$ flake8 soroush_python_sdk tests
$ python setup.py test or py.test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check
https://travis-ci.org/alinik/soroush_python_sdk/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ py.test tests.test_soroush_python_sdk


Deploying
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run::

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.
8 changes: 8 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=======
History
=======

0.1.0 (2018-10-25)
------------------

* First release on PyPI.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2018, Ali Nikneshan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

11 changes: 11 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
include AUTHORS.rst
include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst

recursive-include tests *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]

recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
Loading