Merge pull request #8 from Argmaster/release-1.0.0

Release 1.0.0

Author: Argmaster

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.1
+current_version = 1.0.0
 commit = True
 tag = True
 
@@ -11,6 +11,10 @@ replace = version="{new_version}"
 search = /v{current_version}.svg
 replace = /v{new_version}.svg
 
+[bumpversion:file (badge_ci):README.rst]
+search = pygerber.svg?branch=v{current_version}
+replace = pygerber.svg?branch=v{new_version}
+
 [bumpversion:file (link):README.rst]
 search = /v{current_version}...main
 replace = /v{new_version}...main

.cookiecutterrc

@@ -0,0 +1,56 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+      - release-*
+      - develop
+  pull_request:
+    branches:
+      - main
+      - release-*
+      - develop
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install libpulse0
+          python -m pip install --upgrade pip
+          pip install tox
+
+      - name: Tox -e clean
+        run: |
+          tox -e clean
+
+      - name: Tox -e check
+        run: |
+          tox -e check
+
+      - name: Tox -e py39
+        run: |
+          tox -e py39
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          file: ./coverage.xml

.github/workflows/main.yml

@@ -75,3 +75,9 @@ docs/_build
 
 .vscode/
 render.png
+blender/
+typings/
+*.blend1
+*.blend
+.temp/
+*.glb

.gitignore

@@ -6,3 +6,11 @@ Changelog
 ------------------
 
 * First release on PyPI.
+* Added 2D rendering
+
+1.0.0 (2021-10-06)
+------------------
+
+* Added 3D rendering (not full-featured)
+* Added CLI and API for 3D rendering
+* Installing bpy is required for 3D rendering

.travis.yml

@@ -49,7 +49,7 @@ To set up `pygerber` for local development:
 
    Now you can make your changes locally.
 
-4. When you're done making changes run all the checks and docs builder with `tox <https://tox.readthedocs.io/en/latest/install.html>`_ one command::
+4. When you're done making changes run all the checks and docs builder with `tox <https://github.com/tox-dev/tox>`_ one command::
 
     tox
 
@@ -68,17 +68,11 @@ If you need some code review or feedback while you're developing the code just m
 
 For merging, you should:
 
-1. Include passing tests (run ``tox``) [1]_.
+1. Include passing tests (run ``tox``).
 2. Update documentation when there's new API, functionality etc.
 3. Add a note to ``CHANGELOG.rst`` about the changes.
 4. Add yourself to ``AUTHORS.rst``.
 
-.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
-       `run the tests <https://travis-ci.com/github/Argmaster/pygerber/pull_requests>`_
-       for each change you add in the pull request.
-
-       It will be slower though ...
-
 Tips
 ----
 

CHANGELOG.rst

@@ -1,15 +1,16 @@
 graft docs
 graft src
-graft ci
-graft tests
+
+prune tests
+prune tests/gerber/rendered/*
+prune scripts
+prune .github
 
 include .bumpversion.cfg
 include .cookiecutterrc
 include .coveragerc
 include .editorconfig
 include tox.ini
-include .travis.yml
-include .appveyor.yml
 include .readthedocs.yml
 include .pre-commit-config.yaml
 include AUTHORS.rst
@@ -18,5 +19,4 @@ include CONTRIBUTING.rst
 include LICENSE
 include README.rst
 
-
-global-exclude *.py[cod] __pycache__/* *.so *.dylib
+global-exclude *.py[cod] __pycache__/* *.so *.dylib .temp/*

CONTRIBUTING.rst

@@ -1,22 +1,25 @@
+
 .. image:: https://raw.githubusercontent.com/Argmaster/pygerber/main/docs/_static/pygerber_logo.png
+   :height: 400px
+   :align: center
 
 ========
 Overview
 ========
 
 .. start-badges
 
-|docs| |travis| |codecov| |version| |wheel| |supported-versions| |supported-implementations| |commits-since|
+|docs| |tests| |codecov| |version| |wheel| |supported-versions| |supported-implementations| |commits-since|
 
 .. |docs| image:: https://readthedocs.org/projects/pygerber/badge/?style=flat
     :target: https://pygerber.readthedocs.io/
     :alt: Documentation Status
 
-.. |travis| image:: https://app.travis-ci.com/Argmaster/pygerber.svg?branch=main
-    :alt: Travis-CI Build Status
-    :target: https://travis-ci.com/github/Argmaster/pygerber
+.. |tests| image:: https://github.com/Argmaster/pygerber/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/Argmaster/pygerber
+    :alt: Workflow Status
 
-.. |codecov| image:: https://codecov.io/gh/Argmaster/pygerber/branch/main/graphs/badge.svg?branch=main
+.. |codecov| image:: https://api.travis-ci.com/Argmaster/pygerber.svg?branch=v1.0.0
     :alt: Coverage Status
     :target: https://codecov.io/github/Argmaster/pygerber
 
@@ -36,17 +39,15 @@ Overview
     :alt: Supported implementations
     :target: https://pypi.org/project/pygerber
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/Argmaster/pygerber/v0.0.1.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/Argmaster/pygerber/v1.0.0.svg
     :alt: Commits since latest release
-    :target: https://github.com/Argmaster/pygerber/compare/v0.0.1...main
+    :target: https://github.com/Argmaster/pygerber/compare/v1.0.0...main
 
 .. end-badges
 
 PyGerber is a Python library for 2D and 3D rendering of Gerber X3 files.
 It is completely written in Python, and only dependencies are limiting its portability.
 
-*3D rendering is still under development, it will arrive at next major release. (v1.0.0)*
-
 **This package is a Free Software; it is released under MIT license**. Be aware that dependencies might be using different licenses.
 
 PyGerber offers a CLI and API for Python to allow easy rendering of Gerber files.
@@ -68,26 +69,29 @@ PyGerber is available on PyPI and can be obtained via pip
 
     pip install pygerber
 
-Be aware that this will **only install general and 2D rendering dependencies**, as
-**bpy (Blender) is not officially released as Python package**. You have to obtain
-it yourself, which, for example, you can archive with help of guides contained in
-this `repository <https://github.com/Argmaster/pyr3>`_.
-
-
 You can also install the in-development version from github with
 
 .. code:: bash
 
     pip install https://github.com/Argmaster/pygerber/archive/main.zip
 
-Same Blender dependency issue applies to this installation method.
+Blender dependency issue mentioned in previous releases was resolved by using
+`PyR3 package <https://pypi.org/project/PyR3/>`_ which provides Blender.
+**However, blender has to be installed independently from package by calling PyR3.install_bpy script**::
+
+    python -m PyR3.install_bpy
+
+Before You try to use 3D rendering.
 
 Compatibility
 =============
 
-PyGerber officially supports only Python 3.9, but 2D rendering should be also available for
-3.8 and 3.7, as long as Pillow provides support for those versions. 3D rendering is not
-possible on those versions of Python due to compatibility issues of Blender binaries and Blender's API changes.
+PyGerber officially runs on Python 3.9.* and only on this version.
+However it may be possible to run 2D rendering on other Python versions
+that are supported by Pillow.
+
+I'll consider bringing Python 3.8 3D rendering support, but no sooner than
+after implementation of full set of 3D rendering features and macros support.
 
 Documentation
 =============
@@ -101,28 +105,10 @@ To run all the tests, just run::
 
     tox
 
-To see all the tox environments::
-
-    tox -l
-
 To only build the docs::
 
     tox -e docs
 
 To build and verify that the built package is proper and other code QA checks::
 
     tox -e check
-
-To build sdist, and bdist_wheel::
-
-    python setup.py clean --all sdist bdist_wheel
-
-To make a release of the project on PyPI, assuming you got some distributions in dist/, the most simple usage is::
-
-    twine upload --skip-existing dist/*.whl dist/*.gz dist/*.zip
-
-Credits
-=======
-
-Structure of this project was created using cookiecutter template `cookiecutter-pylibrary <https://github.com/ionelmc/cookiecutter-pylibrary>`_.
-I'm very grateful to Ionel Cristian Mărieș for its creation.