Merge pull request #11 from Garcia6l20/devel

Devel

Author: Garcia6l20

.github/workflows/publish.yaml

@@ -0,0 +1,15 @@
+name: Publish to PyPI.org
+on:
+  release:
+    types: [published]
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - run: python3 -m pip install --upgrade build && python3 -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_KEY }}

README.md

@@ -4,12 +4,28 @@
 
 _dan_ is a build system inspired from _GNU make_, _cmake_, _meson_, ... but only in python.
 
+It is mostly designed to be easy to use, it comes with its [vscode extension](https://github.com/Garcia6l20/dan-vscode) available on the [marketplace](https://marketplace.visualstudio.com/items?itemName=garcia6l20.dan).
+
+It also provide a packaging system called [dan.io](https://github.com/Garcia6l20/dan.io),
+that will fetch and build 3rd party libraries.
+
+## Install
+
+_dan_ is available on pip:
+
+```bash
+pip install dan-build
+```
+
 ## Features
 
-- Generators:
+### Generators
 
 Generators are python functions that generates an output:
+
 ```python
+from dan import generator
+
 @generator(output='hello.txt', dependencies=['source.jinja'])
 def hello(self):
     env = jinja2.Environment(loader=jinja2.FileSystemLoader(self.source_path))
@@ -18,6 +34,7 @@ def hello(self):
 ```
 
 They can be async:
+
 ```python
 @generator(output='hello-cpy.txt', dependencies=[hello])
 async def hello_cpy(self):
@@ -27,8 +44,62 @@ async def hello_cpy(self):
             await dst.write(await src.read())
 ```
 
+### C/CXX
+
+#### Libraries/Executables
+
+```python
+from dan.cxx import Library, Executable
+class MyLib(Library):
+    name = 'my-lib'
+    sources = ['src/my-lib.cpp']
+    public_includes = ['include']
+
+class MyExe(Executable):
+    name = 'my-exe'
+    sources = ['src/main.cpp']
+    dependencies = [MyLib]
+
+```
+
+#### Packages
+
+[dan.io](https://github.com/Garcia6l20/dan.io) is the main (default) package source repository (custom repositories are supported by editting _~/.dan/repositories.json_), documentation comming soon.
+
+```python
+class MyExe(Executable):
+    name = 'my-exe'
+    sources = ['src/main.cpp']
+    dependencies = ['boost:headers@dan.io >= 1.82']
+```
+
+## `dan` cli usage
 
-## Cli usage:
+`dan` is the main executable to build your project, it can build, test, list targets/test, ...
+
+```bash
+dan --help
+Usage: dan [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --version           Show the version and exit.
+  -q, --quiet         Dont print informations (errors only)
+  -v, --verbose       Pring debug informations
+  -j, --jobs INTEGER  Maximum jobs
+  --help              Show this message and exit.
+
+Commands:
+  build            Build targets
+  clean            Clean generated stuff
+  code             VS-Code specific commands
+  configure        Configure dan project
+  install          Install targets
+  ls               Inspect stuff
+  run              Run executable(s)
+  scan-toolchains  Scan system toolchains
+  test             Run tests
+  uninstall        Uninstall previous installation
+```
 
 ### Toolchain scan
 
@@ -50,7 +121,7 @@ dan build [-B <build_path>] [-v] [--for-install] [TARGETS]...
 
 ### Install
 
-Install targets marked with `self.install(...)` to the *install.destination* setting.
+Install targets marked with `install = True` property to the *install.destination* setting.
 
 ```bash
 dan install [-B <build_path>] [TARGETS]... [user|dev]
@@ -63,3 +134,53 @@ Settings:
 - *install.includes_prefix*: Includes installation prefix (default: include).
 - *install.data_prefix*: Data files installation prefix (default: share).
 - *install.project_prefix*: !!! NOT USED YET !!! Project prefix (default: None).
+
+## `dan-io` cli usage
+
+`dan-io` is a secondary utility to interract with package management system.
+
+```bash
+$ dan-io --help 
+Usage: dan-io [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  ls      Inspect stuff
+  search  Search for NAME in repositories
+```
+
+```bash
+$ dan-io ls --help
+Usage: dan-io ls [OPTIONS] COMMAND [ARGS]...
+
+  Inspect stuff
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  libraries     List available libraries
+  repositories  List available repositories
+  versions      Get LIBRARY's available versions
+```
+
+
+## Auto completion
+
+_bash_ and _zsh_ completions are currently supported:
+
+- _bash_:
+    ```bash
+    for script in ~/.local/etc/bash_completion.d/*.sh; do
+        source ${script}
+    done
+    ```
+
+- _ksh_:
+    ```ksh
+    for script in ~/.local/etc/ksh_completion.d/*.sh; do
+        source ${script}
+    done
+    ```

completion/bash/dan-io.sh

@@ -0,0 +1,29 @@
+_dan_io_completion() {
+    local IFS=$'\n'
+    local response
+
+    response=$(env COMP_WORDS="${COMP_WORDS[*]}" COMP_CWORD=$COMP_CWORD _DAN_IO_COMPLETE=bash_complete $1)
+
+    for completion in $response; do
+        IFS=',' read type value <<< "$completion"
+
+        if [[ $type == 'dir' ]]; then
+            COMPREPLY=()
+            compopt -o dirnames
+        elif [[ $type == 'file' ]]; then
+            COMPREPLY=()
+            compopt -o default
+        elif [[ $type == 'plain' ]]; then
+            COMPREPLY+=($value)
+        fi
+    done
+
+    return 0
+}
+
+_dan_io_completion_setup() {
+    complete -o nosort -F _dan_io_completion dan-io
+}
+
+_dan_io_completion_setup;
+

completion/bash/dan.sh

@@ -0,0 +1,29 @@
+_dan_completion() {
+    local IFS=$'\n'
+    local response
+
+    response=$(env COMP_WORDS="${COMP_WORDS[*]}" COMP_CWORD=$COMP_CWORD _DAN_COMPLETE=bash_complete $1)
+
+    for completion in $response; do
+        IFS=',' read type value <<< "$completion"
+
+        if [[ $type == 'dir' ]]; then
+            COMPREPLY=()
+            compopt -o dirnames
+        elif [[ $type == 'file' ]]; then
+            COMPREPLY=()
+            compopt -o default
+        elif [[ $type == 'plain' ]]; then
+            COMPREPLY+=($value)
+        fi
+    done
+
+    return 0
+}
+
+_dan_completion_setup() {
+    complete -o nosort -F _dan_completion dan
+}
+
+_dan_completion_setup;
+

completion/zsh/dan-io.sh

@@ -0,0 +1,35 @@
+#compdef dan-io
+
+_dan_io_completion() {
+    local -a completions
+    local -a completions_with_descriptions
+    local -a response
+    (( ! $+commands[dan-io] )) && return 1
+
+    response=("${(@f)$(env COMP_WORDS="${words[*]}" COMP_CWORD=$((CURRENT-1)) _DAN_IO_COMPLETE=zsh_complete 'dan-io')}")
+
+    for type key descr in ${response}; do
+        if [[ "$type" == "plain" ]]; then
+            if [[ "$descr" == "_" ]]; then
+                completions+=("$key")
+            else
+                completions_with_descriptions+=("$key":"$descr")
+            fi
+        elif [[ "$type" == "dir" ]]; then
+            _path_files -/
+        elif [[ "$type" == "file" ]]; then
+            _path_files -f
+        fi
+    done
+
+    if [ -n "$completions_with_descriptions" ]; then
+        _describe -V unsorted completions_with_descriptions -U
+    fi
+
+    if [ -n "$completions" ]; then
+        compadd -U -V unsorted -a completions
+    fi
+}
+
+compdef _dan_io_completion dan-io;
+

completion/zsh/dan.sh

@@ -0,0 +1,35 @@
+#compdef dan
+
+_dan_completion() {
+    local -a completions
+    local -a completions_with_descriptions
+    local -a response
+    (( ! $+commands[dan] )) && return 1
+
+    response=("${(@f)$(env COMP_WORDS="${words[*]}" COMP_CWORD=$((CURRENT-1)) _DAN_COMPLETE=zsh_complete dan)}")
+
+    for type key descr in ${response}; do
+        if [[ "$type" == "plain" ]]; then
+            if [[ "$descr" == "_" ]]; then
+                completions+=("$key")
+            else
+                completions_with_descriptions+=("$key":"$descr")
+            fi
+        elif [[ "$type" == "dir" ]]; then
+            _path_files -/
+        elif [[ "$type" == "file" ]]; then
+            _path_files -f
+        fi
+    done
+
+    if [ -n "$completions_with_descriptions" ]; then
+        _describe -V unsorted completions_with_descriptions -U
+    fi
+
+    if [ -n "$completions" ]; then
+        compadd -U -V unsorted -a completions
+    fi
+}
+
+compdef _dan_completion dan;
+

dan/__main__.py

@@ -1,4 +1,4 @@
-from dan.cli import main
+from dan.cli.main import main
 
 
 if __name__ == '__main__':

dan/cli/__init__.py

@@ -0,0 +1,22 @@
+from click import *
+
+import inspect
+import asyncio
+
+from dan import logging
+
+class AsyncContext(Context):
+    def invoke(__self, __callback, *args, **kwargs):
+        ret = super().invoke(__callback, *args, **kwargs)
+        if inspect.isawaitable(ret):
+            loop = asyncio.get_event_loop()
+            if loop.is_running():
+                return ret  # must be awaited
+            return loop.run_until_complete(ret)
+        else:
+            return ret
+
+
+BaseCommand.context_class = AsyncContext
+
+logger = logging.getLogger('cli')