Metadata-Version: 2.1
Name: dwas
Version: 0.0.1
Summary: dwas is a command line tool to define and run your development workflows
Author-email: Benjamin Schubert <contact@benschubert.me>
License: MIT
Project-URL: homepage, https://github.com/BenjaminSchubert/dwas
Project-URL: repository, https://github.com/BenjaminSchubert/dwas
Project-URL: tracker, https://github.com/BenjaminSchubert/dwas/issues
Project-URL: documentation, https://dwas.readthedocs.io/en/latest/
Keywords: workflows,virtual,environments,isolated,testing
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
Provides-Extra: test
Provides-Extra: docs
License-File: LICENSE

.. image:: https://readthedocs.org/projects/dwas/badge/?version=latest
   :target: https://dwas.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://github.com/BenjaminSchubert/dwas/actions/workflows/ci.yml/badge.svg
   :target: https://github.com/BenjaminSchubert/dwas/actions/workflows/ci.yml
   :alt: checks badge

.. image:: https://codecov.io/gh/BenjaminSchubert/dwas/branch/main/graph/badge.svg?token=OK872YRU0H
   :target: https://codecov.io/gh/BenjaminSchubert/dwas


Development Workflow ASsistant
==============================

**Flexible developer workflow automation CLI in Python**

``dwas`` takes inspiration from `tox <https://tox.wiki/>`_,
`nox <https://nox.thea.codes/>`_ and `Invoke <https://www.pyinvoke.org/>`_ and
aims to delivers a middle ground, the builtin isolation of tox, together with
the scriptability of nox and the extensibility of Invoke, mixed with dependency
management and provided common use cases.

If ``dwas`` does not satisfy your use case, maybe one of those will?

⚠️ This project is currently in early development. Contributions and issues are
very welcome but compatibility may be broken at any point.


Getting Started
---------------

`A more detailed documentation <https://dwas.readthedocs.io/en/latest/>`_ is
available.


Installation
************

Currently, ``dwas`` is not published on `Pypi <https://pypi.org/>`_ and needs to
be installed from the repository. With pip, you can do the following:

.. code-block:: shell

   # Here PYTHON_VERSION is the version for which you want to install ``dwas``.
   # Remember that it needs at least python3.9. In a virtual environment, using
   # `python` should be enough.
   python${PYTHON_VERSION} -m pip install git+https://github.com/BenjaminSchubert/dwas.git@main

For more information and explanation, please see
`our docs <https://dwas.readthedocs.io/en/latest/installation.html>`__


Running dwas
************

Once installed, you can run ``dwas`` on any project with a ``dwasfile.py`` in
it.

For example, to run all default steps:

.. code-block:: shell

   dwas

Or, to list all the steps available:

.. code-block:: shell

   dwas --list

For more information on how to get started, please see
`our docs <https://dwas.readthedocs.io/en/latest/getting_started.html>`__
