Merge pull request #42 from Miksus/ref/rename_project

Rename project to Rocketry

.coveragerc

@@ -1,5 +1,5 @@
 [run]
-source = redengine
+source = rocketry
 branch = False
 omit = 
     test/*
@@ -10,9 +10,9 @@ data_file = cov_data/.coverage
 [report]
 
 omit = 
-    redengine/test/*
-    redengine/_version.py
-    redengine/__main__.py
+    rocketry/test/*
+    rocketry/_version.py
+    rocketry/__main__.py
 
 # Regexes for lines to exclude from consideration
 exclude_lines =

.gitattributes

@@ -1 +1 @@
-redengine/_version.py export-subst
+rocketry/_version.py export-subst

.github/workflows/main.yml

@@ -43,7 +43,7 @@ jobs:
      
     - name: Run test suite
       run: |
-        python -m pytest --pyargs redengine
+        python -m pytest --pyargs rocketry
     
     # Seems there is a possible problem with pytest-cov parallelization
     #- name: Run test suite

.github/workflows/test_cov.yml

@@ -40,7 +40,7 @@ jobs:
         
     - name: Run test suite
       run: |
-        python -m pytest --cov=redengine --cov-report=xml redengine/test
+        python -m pytest --cov=rocketry --cov-report=xml rocketry/test
         
     - name: Upload test coverage
       uses: codecov/codecov-action@v2

.github/workflows/test_pr.yml

@@ -37,7 +37,7 @@ jobs:
      
     - name: Run test suite
       run: |
-        python -m pytest --pyargs redengine
+        python -m pytest --pyargs rocketry
     
     # Seems there is a possible problem with pytest-cov parallelization
     #- name: Run test suite

MANIFEST.in

@@ -1,9 +1,9 @@
-include redengine/test/test_files/*.ipynb
-include redengine/test/test_files/*.py
-include redengine/config/defaults/*.json
+include rocketry/test/test_files/*.ipynb
+include rocketry/test/test_files/*.py
+include rocketry/config/defaults/*.json
 include versioneer.py
-include redengine/_session.py
-include redengine/_setup.py
-include redengine/_pkg.py
-include redengine/_version.py
-recursive-include redengine/templates *
+include rocketry/_session.py
+include rocketry/_setup.py
+include rocketry/_pkg.py
+include rocketry/_version.py
+recursive-include rocketry/templates *

README.md

@@ -1,28 +1,28 @@
 
-# <span style="color:red">Red</span> Engine
+# Rocketry
 > Powering your Python Apps
 
 -----------------
 
-[![Pypi version](https://badgen.net/pypi/v/redengine)](https://pypi.org/project/redengine/)
-[![build](https://github.com/Miksus/red-engine/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/Miksus/red-engine/actions/workflows/main.yml)
-[![codecov](https://codecov.io/gh/Miksus/red-engine/branch/master/graph/badge.svg?token=U2KF1QA5HT)](https://codecov.io/gh/Miksus/red-engine)
-[![Documentation Status](https://readthedocs.org/projects/red-engine/badge/?version=latest)](https://red-engine.readthedocs.io/en/latest/?badge=latest)
-[![PyPI pyversions](https://badgen.net/pypi/python/redengine)](https://pypi.org/project/redengine/)
+[![Pypi version](https://badgen.net/pypi/v/rocketry)](https://pypi.org/project/rocketry/)
+[![build](https://github.com/Miksus/rocketry/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/Miksus/rocketry/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/Miksus/rocketry/branch/master/graph/badge.svg?token=U2KF1QA5HT)](https://codecov.io/gh/Miksus/rocketry)
+[![Documentation Status](https://readthedocs.org/projects/rocketry/badge/?version=latest)](https://rocketry.readthedocs.io/en/latest/?badge=latest)
+[![PyPI pyversions](https://badgen.net/pypi/python/rocketry)](https://pypi.org/project/rocketry/)
 
 ## What is it?
 
-Red Engine is a modern scheduling framework for Python 
+Rocketry is a modern scheduling framework for Python 
 applications. It is simple, clean and extensive. It is 
 the engine that sets your Python programs alive.
 
 The library is minimal on the surface but extensive 
 and customizable underneath. The syntax very clean:
 
 ```python
-from redengine import RedEngine
+from rocketry import Rocketry
 
-app = RedEngine()
+app = Rocketry()
 
 @app.task('daily')
 def do_daily():
@@ -32,17 +32,17 @@ if __name__ == '__main__':
     app.run()
 ```
 
-Compared to alternatives, Red Engine has perhaps the most elegant syntax and is the most productive. It offers more features than Crontab or APScheduler but is much
+Compared to alternatives, Rocketry has perhaps the most elegant syntax and is the most productive. It offers more features than Crontab or APScheduler but is much
 easier to work with than Airflow. It does not make assumptions of your project.
 
-Read more from the documentations: [Red Engine, documentations](https://red-engine.readthedocs.io/en/stable/)
+Read more from the documentations: [Rocketry, documentations](https://rocketry.readthedocs.io/en/stable/)
 
 ## Installation
 
-Install Red Engine from [PyPI](https://pypi.org/project/redengine/):
+Install Rocketry from [PyPI](https://pypi.org/project/rocketry/):
 
 ```shell
-pip install redengine
+pip install rocketry
 ```
 
 
@@ -71,7 +71,7 @@ def do_twice_a_week_after_ten():
 **Pipelining tasks:**
 
 ```python
-from redengine.args import Return
+from rocketry.args import Return
 
 @app.task("daily after 07:00")
 def do_first():

docs/code/demo.py

@@ -1,7 +1,7 @@
-from redengine import RedEngine
-from redengine.args import Return
+from rocketry import Rocketry
+from rocketry.args import Return
 
-app = RedEngine()
+app = Rocketry()
 
 @app.task('daily')
 def do_daily():

docs/code/demo_basic.py

@@ -1,6 +1,6 @@
-from redengine import RedEngine
+from rocketry import Rocketry
 
-app = RedEngine()
+app = Rocketry()
 
 @app.task('daily')
 def do_things():

docs/code/demos/advanced.py

@@ -1,7 +1,7 @@
-from redengine import RedEngine
-from redengine.args import Return, Arg, FuncArg
+from rocketry import Rocketry
+from rocketry.args import Return, Arg, FuncArg
 
-app = RedEngine()
+app = Rocketry()
 
 # Custom Condition
 # ----------------

docs/code/demos/basic.py

@@ -1,6 +1,6 @@
-from redengine import RedEngine
+from rocketry import Rocketry
 
-app = RedEngine()
+app = Rocketry()
 
 @app.task('daily')
 def do_things():

docs/code/demos/intermediate.py

@@ -1,7 +1,7 @@
-from redengine import RedEngine
-from redengine.args import Return, Arg, FuncArg
+from rocketry import Rocketry
+from rocketry.args import Return, Arg, FuncArg
 
-app = RedEngine()
+app = Rocketry()
 
 @app.cond('is foo')
 def is_foo():

docs/code/demos/minimal.py

@@ -1,6 +1,6 @@
-from redengine import RedEngine
+from rocketry import Rocketry
 
-app = RedEngine()
+app = Rocketry()
 
 @app.task('daily')
 def do_things():

docs/code/demos/monitor.py

@@ -1,8 +1,8 @@
-from redengine import RedEngine
-from redengine.args import Arg
+from rocketry import Rocketry
+from rocketry.args import Arg
 from redmail import EmailSender
 
-app = RedEngine()
+app = Rocketry()
 app.params(receivers=['me@example.com'])
 email = EmailSender(
     host="smtp.myserver.com", port=584,

docs/code/parameter/parameters.py

@@ -1,7 +1,7 @@
-from redengine import RedEngine
-from redengine.args import Arg, Return, FuncArg
+from rocketry import Rocketry
+from rocketry.args import Arg, Return, FuncArg
 
-app = RedEngine()
+app = Rocketry()
 app.params(my_arg='hello')
 
 @app.task("every 10 seconds")

docs/code/parameter/pipelining.py

@@ -1,4 +1,4 @@
-from redengine.args import Return
+from rocketry.args import Return
 
 @app.task("every 10 seconds")
 def do_things():

docs/code/snippets/parametrize.py

@@ -1,4 +1,4 @@
-from redengine.args import Arg
+from rocketry.args import Arg
 
 @app.param('my_param')
 def get_my_param():

docs/code/snippets/pipeline.py

@@ -1,4 +1,4 @@
-from redengine.args import Return
+from rocketry.args import Return
 
 @app.task("daily after 07:00")
 def do_first():

docs/conf.py

@@ -18,7 +18,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'redengine'
+project = 'rocketry'
 copyright = '2021, Mikael Koli'
 author = 'Mikael Koli'
 
@@ -43,8 +43,8 @@
 
 doctest_global_setup = '''
 def cleanup():
-    from redengine import Session
-    from redengine.core.hook import clear_hooks
+    from rocketry import Session
+    from rocketry.core.hook import clear_hooks
     Session.default_config['task_pre_exist'] = 'replace'
 
     clear_hooks()
@@ -77,7 +77,7 @@ def cleanup():
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_title = "Red Engine: Advanced Scheduler"
+html_title = "Rocketry: Advanced Scheduler"
 html_theme = 'sphinx_book_theme'
 html_logo = "logo.svg"
 html_favicon = 'favicon.ico'

docs/contributing.rst

@@ -3,6 +3,6 @@ Contributing
 ============
 
 All help is welcome. If you found a bug or have ideas or suggestions,
-please create an issue in `Red Engine Github page <https://github.com/Miksus/red-engine>`_.
+please create an issue in `Rocketry Github page <https://github.com/Miksus/rocketry>`_.
 Also pull requests are welcome.
 

docs/how_it_works.rst

@@ -3,9 +3,9 @@
 How it works?
 =============
 
-There are four core components in Red Engine's ecosystem:
+There are four core components in Rocketry's ecosystem:
 
-- **RedEngine**: acts as the top level interface
+- **Rocketry**: acts as the top level interface
 - **Session**: handles the configuration and act as a medium level interface
 - **Scheduler**: handles the flow of the system
 - **Task**: handles how to execute a task

docs/index.rst

@@ -1,24 +1,24 @@
 
 .. meta::
-   :description: Red Engine, modern scheduling framework
+   :description: Rocketry, modern scheduling framework
    :keywords: schedule, task, script, run, Python
 
-:red:`Red` Engine
-=================
+Rocketry
+========
 
-.. image:: https://badgen.net/pypi/v/redengine
-   :target: https://pypi.org/project/redengine/
+.. image:: https://badgen.net/pypi/v/rocketry
+   :target: https://pypi.org/project/rocketry/
 
-.. image:: https://badgen.net/pypi/python/redengine
-   :target: https://pypi.org/project/redengine/
+.. image:: https://badgen.net/pypi/python/rocketry
+   :target: https://pypi.org/project/rocketry/
 
 .. raw:: html
 
    <hr>
 
 No time to read? :ref:`Get started then. <getting-started>`
 
-Red Engine is a modern scheduling framework for Python 
+Rocketry is a modern scheduling framework for Python 
 applications. It is simple, clean and extensive.
 
 **Key features:**
@@ -42,7 +42,7 @@ applications. It is simple, clean and extensive.
 .. literalinclude:: /code/demos/minimal.py
     :language: py
 
-Why Red Engine?
+Why Rocketry?
 ---------------
 
 There are a lot of options for scheduler:
@@ -51,12 +51,12 @@ There are a lot of options for scheduler:
 - APScheduler
 - Airflow
 
-Red Engine provides more features than Crontab and APScheduler
-and it is much easier to use than Airflow. Red Engine
+Rocketry provides more features than Crontab and APScheduler
+and it is much easier to use than Airflow. Rocketry
 has by far the cleanest syntax compared to the alternatives and it is 
 the most productive.
 
-Red Engine is not meant to be the scheduler for enterprise pipelines,
+Rocketry is not meant to be the scheduler for enterprise pipelines,
 unlike Airflow, but it is fantastic to power your Python applications.
 
 Here is a demonstration of more advanced case:
@@ -72,7 +72,7 @@ Just install the library:
 
 .. code-block:: console
 
-    pip install redengine
+    pip install rocketry
 
 There is much more to offer. See :ref:`quick start <getting-started>`
 And the rest :ref:`tutorials <tutorials>`.

docs/tutorial/advanced.rst

@@ -15,7 +15,7 @@ The configurations can be set by:
 
 .. code-block:: python
 
-    app = RedEngine(config={
+    app = Rocketry(config={
         'task_execution': 'process',
         'task_pre_exist': 'raise',
         'force_status_from_logs': True,
@@ -121,7 +121,7 @@ To alter the session:
 
 .. code-block:: python
 
-    from redengine.args import Session
+    from rocketry.args import Session
 
     @app.task('every 20 hours', execution="thread")
     def do_shutdown(session=Session()):