Merge branch 'release/1.0.0b1'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: smertiens
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment**
+Operating system name and version, Python version, versions of other relevant components (pip, Pillow, ...)
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]"
+labels: enhancement
+assignees: smertiens
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -8,4 +8,5 @@ doc/source/api/*
 playground
 fileformat.txt
 dist
-build
+build
+demo_*

.travis.yml

@@ -0,0 +1,15 @@
+language: python
+python:
+  - "3.4"
+  - "3.5"
+  - "3.5-dev"  # 3.5 development branch
+  - "3.6"
+  - "3.6-dev"  # 3.6 development branch
+  - "3.7-dev"  # 3.7 development branch
+# command to install dependencies
+install:
+  - pip install Pillow
+  - export PYTHONPATH=$PYTHONPATH:$(pwd)/src
+# command to run tests
+script:
+  - python -m unittest

README.md

@@ -1,11 +1,14 @@
 # AtraxiFlow
 The flexible python workflow tool
 
+[![Build Status](https://travis-ci.org/smertiens/AtraxiFlow.svg?branch=develop)](https://travis-ci.org/smertiens/AtraxiFlow)
+
 Documentation and PIP package will be available as soon as initial testing is complete.
 
 * Easy and readable
 * Write your own nodes within minutes
 * No dependencies (unless you want to use the ImageProcessing nodes :)
+* Requires at least python 3.4
 
 **Install**
 ```

build_package_production.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+rm dist/*
+python3 setup.py sdist bdist_wheel
+python3 -m twine upload dist/*
+
+# cleanup
+rm -rf build
+rm -rf src/atraxi_flow.egg-info/

build_package.sh → build_package_test.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-
+rm dist/*
 python3 setup.py sdist bdist_wheel
 python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 

doc/makedoc.sh

@@ -1,2 +1,4 @@
+#!/usr/bin/env bash
+rm -rf source/api
 sphinx-apidoc -f -H "API Documentation" -A "Sean Mertiens" -V "1.0.0" -o source/api ../src
 sphinx-build source/ build/

doc/source/basics.rst

@@ -5,7 +5,7 @@ AtraxiFlow is a workflow tool for Python. It is meant to be simple, inuitive and
 flexible. Everyone familiar with basic python scripting should be able to create
 complex workflows without reading extensive API docs or manuals.
 
-AtraxiFlow consists of three major elements: :ref:`manual/streams`, :ref:`manual/nodes` and :ref:`manual/resources`.
+AtraxiFlow consists of three major elements: :doc:`/manual/streams`, :doc:`/manual/nodes` and :doc:`/manual/resources`.
 The following image will help you understand how they work together:
 
 **Streams** are the basic building blocks. They hold all other components. Think of them as
@@ -15,7 +15,7 @@ a stream of water, like a river. They will take you from the start of your scrip
 **Resources** provide things you can work with in your stream, for example Files, Images, Texts or
 more complex things like data from a database or the internet. Resources have different
 *properties* that determine how they behave or where they should get their data from.
-The :ref:`FilesystemResource` for example has a *sourcePattern*-Property. You can set it to
+The :ref:`fsres` for example has a *src*-Property. You can set it to
 a file like "/hello/world.txt". You can now access the file at anytime using the stream.
 So you can throw any resource into your stream and fish it out any time you need it.
 

doc/source/conf.py

@@ -83,7 +83,8 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
+html_theme='sphinx_rtd_theme'
 #html_theme = 'guzzle_sphinx_theme'
 #html_theme_path = guzzle_sphinx_theme
 

doc/source/developer.rst

@@ -44,11 +44,3 @@ A basic node looks like this:
 
 Add the usage of primaryProperties
 
-Get data from stream:
-
-Stream.getResource("ResType::*") -> gets all of ResType
-Stream.getResource("ResType::resname") -> gets resource with name "resname"
-Stream.getResource("ResType::resname.value") -> gets property with name "value". Can be changed by overwriting getData() in Node (e.g. Database)
-
-
-.. automodule:: Stream

doc/source/gettingstarted.rst

@@ -7,7 +7,7 @@ Installation
 **Using pip (recommended)**
 Install via the python package manager: ::
 
-    python3 pip install atraxi-flow
+    python pip install atraxi-flow
 
 
 **Downloading**
@@ -31,3 +31,4 @@ To get you started we will write a small workflow that will do the following thi
 2. Put the files in a zip file
 3. Write a friendly message for the user when the workflow is finished
 
+.. todo:: Add small tutorial

doc/source/index.rst

@@ -4,12 +4,10 @@ AtraxiFlow Documentation
 Welcome to AtraxiFlow documentation, the flexible workflow tool for python.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 3
    :caption: Contents:
 
    basics
    gettingstarted
    manual/index
-   developer
-   api/modules
-
+   api/modules