Before you begin, ensure you have the following prerequisites installed:
- Python 3.12 or higher
- pip (Python package manager)
-
Clone the repository to your local machine:
git clone https://github.com/xKabbe/spark.git
-
Set up and activate a virtual environment:
# On linux python -m venv path/to/venv source path/to/venv/bin/activate # On windows python -m venv path/to/venv source path/to/venv/Scripts/activate
-
Install the required dependencies:
pip install -r requirements.txt
Coming soon...
pytest makes it easy to write small, readable tests, and can scale to support complex functional testing for applications and libraries.
| Command | Description |
|---|---|
pytest |
Run all tests in the current directory and its subdirectories. |
pytest test_module.py |
Run tests in a specific module. |
pytest test_module.py::test_fn |
Run a specific test function in a module. |
pytest -k expression |
Run tests that match the given keyword expression. |
pytest -m marker |
Run tests that have a specific marker. |
pytest --headless |
Run tests in headless mode (doesn't show browser window). |
pytest --fixtures |
Show available fixtures. |
pytest --cov=your_module |
Measure code coverage for your module. Requires the pytest-cov plugin. |
pytest --junitxml=result.xml |
Generate JUnit-style XML reports. |
pytest --html=report.html |
Generate an interactive HTML report. Requires the pytest-html plugin. |
pytest --durations=n |
Show n slowest test durations. |
pytest --markers |
Show available markers. |
pytest -h |
Display help message and exit. |
MkDocs is a fast, simple, and widely used tool for creating documentation from Markdown files. To view the project documentation locally and start a live-reloading server, follow these commands:
| Command | Description |
|---|---|
mkdocs serve |
This command will start a local development server, and you can access the documentation at http://127.0.0.1:8000/. As you make changes to the documentation files, MkDocs will automatically update the rendered content in your browser |
mkdocs build |
This command will build the documentation site |
mkdocs -h |
This command will print the help message and exit |
If you'd like to contribute to Spark, please follow the guidelines in CONTRIBUTING.
This project is licensed under the MIT License. See the LICENSE file for details.