Skip to content
Permalink
Browse files

Started writting 3.0 version.

  • Loading branch information...
javipalanca committed Oct 6, 2017
1 parent a8f3c90 commit 39091c892ca12a28d253e0fc3cb8ac44e8109652
Showing with 1,599 additions and 36 deletions.
  1. +21 −0 .editorconfig
  2. +15 −0 .github/ISSUE_TEMPLATE.md
  3. +45 −36 .gitignore
  4. +26 −0 .travis.yml
  5. +13 −0 AUTHORS.rst
  6. +114 −0 CONTRIBUTING.rst
  7. +8 −0 HISTORY.rst
  8. +11 −0 LICENSE
  9. +14 −0 MANIFEST.in
  10. +87 −0 Makefile
  11. +40 −0 README.rst
  12. +3 −0 docs/.gitignore
  13. +177 −0 docs/Makefile
  14. +1 −0 docs/authors.rst
  15. +274 −0 docs/conf.py
  16. +1 −0 docs/contributing.rst
  17. +1 −0 docs/history.rst
  18. +22 −0 docs/index.rst
  19. +51 −0 docs/installation.rst
  20. +242 −0 docs/make.bat
  21. +1 −0 docs/readme.rst
  22. +7 −0 docs/usage.rst
  23. +2 −0 requirements.txt
  24. +12 −0 requirements_dev.txt
  25. +22 −0 setup.cfg
  26. +57 −0 setup.py
  27. +7 −0 spade/__init__.py
  28. +49 −0 spade/agent.py
  29. +67 −0 spade/behaviour.py
  30. +17 −0 spade/cli.py
  31. +3 −0 tests/__init__.py
  32. +37 −0 tests/test_spade.py
  33. +27 −0 tox.ini
  34. +125 −0 travis_pypi_setup.py
@@ -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
@@ -0,0 +1,15 @@
* SPADE 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.
```
@@ -1,53 +1,62 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Packages
*.egg
*.egg-info
dist
build
eggs
parts
bin
var
sdist
develop-eggs
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
lib
lib64
*.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
.tox
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
*.mo
*.pot

# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Mr Developer
.mr.developer.cfg
.project
.pydevproject
spade.nja

.idea
.ipynb_checkpoints

#SPADE files
caseDB
roomdb.xml
spade.xml
test-reports
test/logic/test_flora.P
test/logic/test_flora.fdb
test/logic/test_flora.fld
test/logic/test_flora_main.xwam
test/logic/test_xsb.xwam
user_db.xml
user_db.dbm
xmppd.xml
# pyenv python configuration file
.python-version
@@ -0,0 +1,26 @@
# Config file for automatic testing at travis-ci.org
# This file will be regenerated if you run travis_pypi_setup.py

language: python
python:
- 3.5
- 3.4

# 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

# After you create the Github repo and add it to Travis, run the
# travis_pypi_setup.py script to finish PyPI deployment setup
deploy:
provider: pypi
distributions: sdist bdist_wheel
user: jpalanca
password:
secure: PLEASE_REPLACE_ME
on:
tags: true
repo: javipalanca/spade
python: 3.6
@@ -0,0 +1,13 @@
=======
Credits
=======

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

* Javi Palanca <jpalanca@gmail.com>

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

None yet. Why not be the first?
@@ -0,0 +1,114 @@
.. 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/javipalanca/spade/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
~~~~~~~~~~~~~~~~~~~

SPADE could always use more documentation, whether as part of the
official SPADE 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/javipalanca/spade/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 `spade` for local development.

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

$ git clone git@github.com:your_name_here/spade.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 spade
$ cd spade/
$ 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 spade 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.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
https://travis-ci.org/javipalanca/spade/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_spade

@@ -0,0 +1,8 @@
=======
History
=======

3.0.0 (2017-10-06)
------------------

* Started writting 3.0 version.
11 LICENSE
@@ -0,0 +1,11 @@

MIT License

Copyright (c) 2017, Javi Palanca

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.

@@ -0,0 +1,14 @@
include AUTHORS.rst
include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst

include requirements.txt
include requirements_dev.txt

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

recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
Oops, something went wrong.

0 comments on commit 39091c8

Please sign in to comment.
You can’t perform that action at this time.