Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<table>
<tr>
<td>
Expand All @@ -15,37 +14,43 @@
[![Java CI with Maven](https://github.com/Glimmr-Lang/PicassoCode/actions/workflows/maven.yml/badge.svg)](https://github.com/Glimmr-Lang/PicassoCode/actions/workflows/maven.yml)

## About

Piccasso code is an image editor that uses code to create/edit an image. This allows powerful designs to be created with ease and
automation. The editor uses *glimr* as the scripting language for writing the image editing code.
automation. The editor uses _glimr_ as the scripting language for writing the image editing code.

## Download
>> Coming soon

> > Coming soon

## Building

```sh
$ git clone git@github.com:hexaredecimal/Piccode.git
$ cd Piccode
$ mvn package
git clone git@github.com:hexaredecimal/Piccode.git
cd Piccode
mvn package
```

### Test your build

```sh
$ java -jar target/Piccode-1.0-SNAPSHOT-jar-with-dependencies.jar
java -jar target/Piccode-1.0-SNAPSHOT-jar-with-dependencies.jar
```


## Inspired by

Piccassocode is heavily inspired by the [OpenSCAD](https://openscad.org/) program and tries to mimic its functionality
as much as it can while still being an image editor. I was stoked when I tried OpenSCAD for the first time and ended up
challenging myself to start a new project based araound the idea. A friend suggested something that has to do with graphics
and my first though was OpenSCAD, but 2D. The idea quickly grew and the small program became an image editor.
challenging myself to start a new project based around the idea. A friend suggested something that has to do with graphics
and my first though was OpenSCAD, but 2D. The idea quickly grew and the small program became an image editor.

## References

[java image filters](http://www.jhlabs.com/ip/filters/index.html)

[Icons8 Pack](https://icons8.com/icons/parakeet--style-parakeet)

## License

```sh
drawString("
+-----------------------------------+
Expand All @@ -56,7 +61,5 @@ drawString("
+-----------------------------------+
", 0, 0) // Released under the MIT LICENSE
```
>> Thank you for viewing.



> > Thank you for viewing.
10 changes: 10 additions & 0 deletions pytest.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[tool:pytest]
testpaths = tests
python_files = test_*.py
python_classes = Test*
python_functions = test_*
addopts = -v --tb=short --strict-markers
markers =
slow: marks tests as slow (deselect with '-m "not slow"')
integration: marks tests as integration tests
unit: marks tests as unit tests
4 changes: 4 additions & 0 deletions requirements-test.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
pytest>=7.0.0
pytest-mock>=3.6.1
requests>=2.25.1
pathlib2>=2.3.7; python_version < '3.4'
36 changes: 36 additions & 0 deletions run_readme_tests.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
#!/usr/bin/env python3
"""
Simple test runner for README validation tests.
Run this script to execute all README-related tests.
"""

import subprocess
import sys
import os

def main():
"""Run the README validation tests."""
try:
# Change to the repository root directory
repo_root = os.path.dirname(os.path.abspath(__file__))
os.chdir(repo_root)

# Run pytest with verbose output
result = subprocess.run([
sys.executable, "-m", "pytest",
"tests/test_readme_validation.py",
"-v", "--tb=short"
], capture_output=False)

return result.returncode

except FileNotFoundError:
print("Error: pytest not found. Please install pytest:")
print("pip install -r requirements-test.txt")
return 1
except Exception as e:
print(f"Error running tests: {e}")
return 1

if __name__ == "__main__":
sys.exit(main())
Loading