chore(pep517): Using setup.cfg + pyproject.toml for build the .whl package

Author: mfdeveloper

.gitignore

@@ -112,6 +112,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+version.py
 
 # Spyder project settings
 .spyderproject

README.md

@@ -68,11 +68,20 @@ Quick way:
 pip install surface_reconstruction
 ```
 
-Or clone this repository and run from the project root:
+Or clone this repository and build the `.whl` file from the project root:
 
 ```bash
-python setup.py install
+cd [your-project-root]
+
+# Build the .whl package file
+python -m build --sdist --wheel .
+
+# Install locally from the .whl file
+# Where: x.x.x is the generated version from git tag
+pip install dist/surface_reconstruction-x.x.x-py3-none-any.whl
 ```
+> For more detailed, see the Wiki pages in: [Generate package](https://github.com/mfdeveloper/surface_reconstruction_python/wiki/Generate-package)
+
 
 ### Run the unit tests
 

pyproject.toml

@@ -1,5 +1,9 @@
-[build-system]
-requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
-
-[tool.setuptools_scm]
-write_to = "surface_reconstruction/version.py"
+[build-system]
+requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "surface_reconstruction/version.py"
+version_scheme = "python-simplified-semver"
+# Adds +dirty if the current workdir has changes
+local_scheme = "dirty-tag"

requirements-dev.txt

@@ -5,4 +5,5 @@ setuptools~=54.1.0
 wheel~=0.36.2
 twine~=3.3.0
 tqdm~=4.59.0
-setuptools-scm~=5.0.2
+setuptools-scm~=5.0.2
+build==0.3.1

requirements.txt

@@ -1,3 +1,3 @@
-open3d==0.12.0
-pymeshlab==0.2
-numpy~=1.20.1
+--index-url https://pypi.python.org/simple/
+
+.

setup.cfg

@@ -0,0 +1,35 @@
+# Reference: https://setuptools.readthedocs.io/en/latest/build_meta.html
+
+[metadata]
+name = surface_reconstruction
+author = Felipe Michel Ferreira
+author_email = mfelipeof@gmail.com
+description = Import a point cloud file and perform poisson 3D surface reconstruction algorithm, integrated with third-party libraries (e.g. open3d, pymeshlab...)
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/mfdeveloper/surface_reconstruction_python
+keywords = point-cloud, surface-reconstruction, 3d-processor, 3d-rendering, 3D, poisson, open3d, meshlab
+license = MIT
+classifiers =
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+    Topic :: Multimedia :: Graphics :: 3D Rendering
+    Environment :: GPU
+    Development Status :: 5 - Production/Stable
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.8
+
+[options]
+include_package_data = True
+python_requires = >=3.3
+packages = find:
+install_requires =
+    open3d ==0.12
+    pymeshlab ==0.2
+    numpy
+
+[options.data_files]
+data =
+    files/complex_terrain/list_vertex.ply
+    files/simple_terrain/list_vertex.ply
+    files/filter_scripts/filter_script.mlx

setup.ps1

@@ -3,6 +3,8 @@ param (
     [string]
     $VirtualEnvFolder = 'venv',
     [bool]
+    $Force = $true,
+    [bool]
     $Execute = $true
 )
 
@@ -148,7 +150,6 @@ function Mount-Virtual-Env {
 #>
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory = $false)]
         [string]
         $FolderName = 'venv'
     )
@@ -157,6 +158,11 @@ function Mount-Virtual-Env {
         Write-Error "The virtualenv folder '$FolderName' is invalid"
         return $false
     }
+
+    if ($Force) {
+        Write-Host "Removing folder '$FolderName' ..."
+        Remove-Item ".\$FolderName" -Force
+    }
 
     if ( -not(Test-Path ".\$FolderName") ) {
         Write-Host 'Creating Python VIRTUAL ENVIRONMENT:'
@@ -202,7 +208,7 @@ function Install-Packages-Dependencies {
     }
 
     if (!$invokedInstall) {
-        Write-Information 'requirements.txt file was not found'
+        Write-Host 'requirements.txt file was not found'
     }
 
 }