rename to mona, start versioning from 0.1

Author: jhrmnn

README.md

@@ -1,48 +1,48 @@
-# Caf
-
-[![build](https://img.shields.io/travis/azag0/calcfw/master.svg)](https://travis-ci.org/azag0/calcfw)
-[![coverage](https://img.shields.io/codecov/c/github/azag0/calcfw.svg)](https://codecov.io/gh/azag0/calcfw)
-![python](https://img.shields.io/pypi/pyversions/calcfw.svg)
-[![pypi](https://img.shields.io/pypi/v/calcfw.svg)](https://pypi.org/project/calcfw/)
-[![commits since](https://img.shields.io/github/commits-since/azag0/calcfw/latest.svg)](https://github.com/azag0/calcfw/releases)
-[![last commit](https://img.shields.io/github/last-commit/azag0/calcfw.svg)](https://github.com/azag0/calcfw/commits/master)
-[![license](https://img.shields.io/github/license/azag0/calcfw.svg)](https://github.com/azag0/calcfw/blob/master/LICENSE)
+# Mona
+
+[![build](https://img.shields.io/travis/azag0/mona/master.svg)](https://travis-ci.org/azag0/mona)
+[![coverage](https://img.shields.io/codecov/c/github/azag0/mona.svg)](https://codecov.io/gh/azag0/mona)
+![python](https://img.shields.io/pypi/pyversions/mona.svg)
+[![pypi](https://img.shields.io/pypi/v/mona.svg)](https://pypi.org/project/mona/)
+[![commits since](https://img.shields.io/github/commits-since/azag0/mona/latest.svg)](https://github.com/azag0/mona/releases)
+[![last commit](https://img.shields.io/github/last-commit/azag0/mona.svg)](https://github.com/azag0/mona/commits/master)
+[![license](https://img.shields.io/github/license/azag0/mona.svg)](https://github.com/azag0/mona/blob/master/LICENSE)
 [![code style](https://img.shields.io/badge/code%20style-black-202020.svg)](https://github.com/ambv/black)
 
-Caf is a distributed calculation framework that turns normal execution of Python functions into a graph of tasks. Each task is hashed by the code of its function and its inputs, and the result of each executed task is cached. The cache can be stored persistently in an SQLite database. Tasks and their results can be exchanged between different machines via SSH.
+Mona is a distributed calculation framework that turns normal execution of Python functions into a graph of tasks. Each task is hashed by the code of its function and its inputs, and the result of each executed task is cached. The cache can be stored persistently in an SQLite database. Tasks and their results can be exchanged between different machines via SSH.
 
 ## Installing
 
 Install and update using [Pip](https://pip.pypa.io/en/stable/quickstart/).
 
 ```
-pip install -U calcfw
+pip install -U mona
 ```
 
 ## Links
 
-- Documentation: https://azag0.github.io/calcfw
+- Documentation: https://azag0.github.io/mona
 
 ## A simple example
 
 ```python
-import caf
+from mona import Rule, Session
 
-@caf.Rule
+@Rule
 async def total(xs):
     return sum(xs)
 
-@caf.Rule
+@Rule
 async def fib(n):
     if n < 2:
         return n
     return total([fib(n - 1), fib(n - 2)])
 
-with caf.Session() as sess:
+with Session() as sess:
     sess.eval(fib(5))
     dot = sess.dot_graph()
-dot.render('fib.gv', view=True, format='svg')
+dot.render(view=True)
 ```
 
-![](https://raw.githubusercontent.com/azag0/calcfw/master/docs/fib.gv.svg?sanitize=true)
+![](https://raw.githubusercontent.com/azag0/mona/master/docs/fib.gv.svg?sanitize=true)
 

docs/api.rst

@@ -4,7 +4,7 @@ API
 Rules and Sessions
 ------------------
 
-.. module:: caf
+.. module:: mona
 
 .. autoclass:: Rule
     :members:
@@ -22,7 +22,7 @@ Rules and Sessions
     :members:
 
 
-.. module:: caf.rules
+.. module:: mona.rules
 
 Directory tasks
 ---------------
@@ -38,7 +38,7 @@ Scientific calculations
 Molecular and crystal geometries
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. module:: caf.sci.geomlib
+.. module:: mona.sci.geomlib
 
 .. autoclass:: Atom
     :members:
@@ -58,7 +58,7 @@ Molecular and crystal geometries
 FHI-aims
 ^^^^^^^^
 
-.. module:: caf.sci.aims
+.. module:: mona.sci.aims
 
 .. autoclass:: Aims
     :members:
@@ -72,21 +72,21 @@ Futures and Tasks
 The following classes are not intended for direct use by the end user, but are
 part of the versioned public API neverthless.
 
-.. autoclass:: caf.futures.Future
+.. autoclass:: mona.futures.Future
     :members:
 
-.. autoclass:: caf.hashing.HashedComposite
+.. autoclass:: mona.hashing.HashedComposite
     :members:
     :inherited-members:
 
-.. autoclass:: caf.tasks.Task
+.. autoclass:: mona.tasks.Task
     :members:
     :inherited-members:
 
-.. autoclass:: caf.tasks.TaskComposite
+.. autoclass:: mona.tasks.TaskComposite
     :members:
     :inherited-members:
 
-.. autoclass:: caf.tasks.TaskComponent
+.. autoclass:: mona.tasks.TaskComponent
     :members:
     :inherited-members:

docs/cli.rst

@@ -3,7 +3,7 @@ CLI
 
 .. code-block:: none
 
-    Usage: caf [OPTIONS] COMMAND [ARGS]...
+    Usage: mona [OPTIONS] COMMAND [ARGS]...
 
     Options:
       --help  Show this message and exit.
@@ -18,7 +18,7 @@ CLI
 
 .. code-block:: none
 
-    Usage: caf run [OPTIONS] RULE
+    Usage: mona run [OPTIONS] RULE
 
       Run a given rule.
 

docs/conf.py

@@ -12,7 +12,7 @@
 with open('../pyproject.toml') as f:
     metadata = toml.load(f)['tool']['poetry']
 
-project = 'Caf'
+project = 'Mona'
 version = metadata['version']
 author = ' '.join(metadata['authors'][0].split()[:-1])
 description = metadata['description']
@@ -37,7 +37,7 @@
     'description': description,
     'github_button': True,
     'github_user': 'azag0',
-    'github_repo': 'calcfw',
+    'github_repo': 'mona',
     'badge_branch': 'master',
     'codecov_button': True,
     'travis_button': True,

docs/index.rst

@@ -1,5 +1,5 @@
-Welcome to Caf
-==============
+Welcome to Mona
+===============
 
 Only scaffolding of the planned documentation is available now.
 

caf/__init__.py mona/__init__.pycaf/__init__.py renamed to mona/__init__.py

@@ -16,19 +16,19 @@
 
 
 class App:
-    CAFDIR = '.caf'
+    MONADIR = '.mona'
     TMPDIR = 'tmpdir'
     FILES = 'files'
     CACHE = 'cache.db'
 
-    def __init__(self, cafdir: Pathable = None) -> None:
-        cafdir = cafdir or os.environ.get('CAF_DIR') or App.CAFDIR
-        self._cafdir = Path(cafdir).resolve()
+    def __init__(self, monadir: Pathable = None) -> None:
+        monadir = monadir or os.environ.get('MONA_DIR') or App.MONADIR
+        self._monadir = Path(monadir).resolve()
         self._config: Dict[str, Any] = {}
         for path in [
-            Path('~/.config/caf/config.toml').expanduser(),
-            Path('caf.toml'),
-            self._cafdir / 'config.toml',
+            Path('~/.config/mona/config.toml').expanduser(),
+            Path('mona.toml'),
+            self._monadir / 'config.toml',
         ]:
             if path.exists():
                 with path.open() as f:
@@ -48,30 +48,30 @@ def __call__(
     ) -> None:
         self._plugins = {
             'parallel': Parallel(ncores),
-            'tmpdir': TmpdirManager(self._cafdir / App.TMPDIR),
-            'files': FileManager(self._cafdir / App.FILES),
+            'tmpdir': TmpdirManager(self._monadir / App.TMPDIR),
+            'files': FileManager(self._monadir / App.FILES),
             'cache': Cache.from_path(
-                self._cafdir / App.CACHE, full_restore=full_restore, readonly=readonly
+                self._monadir / App.CACHE, full_restore=full_restore, readonly=readonly
             ),
         }
         for plugin in self._plugins.values():
             plugin(sess)
 
-    def ensure_cafdir(self) -> None:
-        if self._cafdir.is_dir():
-            log.info(f'Already initialized in {self._cafdir}.')
+    def ensure_monadir(self) -> None:
+        if self._monadir.is_dir():
+            log.info(f'Already initialized in {self._monadir}.')
             return
-        log.info(f'Initializing an empty repository in {self._cafdir}.')
-        self._cafdir.mkdir()
+        log.info(f'Initializing an empty repository in {self._monadir}.')
+        self._monadir.mkdir()
         try:
             cache_home = Path(self._config['cache'])
         except KeyError:
             for dirname in [App.TMPDIR, App.FILES]:
-                (self._cafdir / dirname).mkdir()
+                (self._monadir / dirname).mkdir()
         else:
             ts = get_timestamp()
             cachedir = cache_home / f'{Path.cwd().name}_{ts}'
             cachedir.mkdir()
             for dirname in [App.TMPDIR, App.FILES]:
                 (cachedir / dirname).mkdir()
-                (self._cafdir / dirname).symlink_to(cachedir / dirname)
+                (self._monadir / dirname).symlink_to(cachedir / dirname)

caf/cli/__init__.py mona/cli/__init__.pycaf/cli/__init__.py renamed to mona/cli/__init__.py

@@ -26,7 +26,7 @@
 )
 log = logging.getLogger(__name__)
 log.setLevel(logging.INFO)
-logging.getLogger('caf').setLevel(int(os.environ.get('CAF_DEBUG', logging.INFO)))
+logging.getLogger('mona').setLevel(int(os.environ.get('MONA_DEBUG', logging.INFO)))
 
 
 @click.group()
@@ -39,7 +39,7 @@ def cli(ctx: click.Context) -> None:
 @click.pass_obj
 def init(app: App) -> None:
     """Initialize a Git repository."""
-    app.ensure_cafdir()
+    app.ensure_monadir()
 
 
 class TaskFilter:
@@ -77,7 +77,7 @@ def __call__(self, task: Task[Any], exc: Exception) -> bool:
 @click.option('-j', '--cores', type=int, help='Number of cores')
 @click.option('-l', '--limit', type=int, help='Limit number of tasks to N')
 @click.option('--maxerror', default=5, help='Number of errors in row to quit')
-@click.argument('rulename', metavar='RULE', envvar='CAF_RULE')
+@click.argument('rulename', metavar='RULE', envvar='MONA_RULE')
 @click.pass_obj
 def run(
     app: App,
@@ -103,7 +103,7 @@ def run(
 
 @cli.command()
 @click.option('-p', '--pattern', multiple=True, help='Patterns to be reported')
-@click.argument('rulename', metavar='RULE', envvar='CAF_RULE')
+@click.argument('rulename', metavar='RULE', envvar='MONA_RULE')
 @click.pass_obj
 def status(app: App, rulename: str, pattern: List[str]) -> None:
     """Print status of tasks."""
@@ -144,7 +144,7 @@ def status(app: App, rulename: str, pattern: List[str]) -> None:
 
 
 @cli.command()
-@click.argument('rulename', metavar='RULE', envvar='CAF_RULE')
+@click.argument('rulename', metavar='RULE', envvar='MONA_RULE')
 @click.pass_obj
 def graph(app: App, rulename: str) -> None:
     """Open a pdf with the task graph."""
@@ -162,7 +162,7 @@ def graph(app: App, rulename: str) -> None:
 @click.option('-f', '--force', is_flag=True, help='Remove PATH if exists')
 @click.option('--done', is_flag=True, help='Check out only finished tasks')
 @click.option('-c', '--copy', is_flag=True, help='Copy instead of symlinking')
-@click.argument('rulename', metavar='RULE', envvar='CAF_RULE')
+@click.argument('rulename', metavar='RULE', envvar='MONA_RULE')
 @click.pass_obj
 def checkout(
     app: App,