packaging started

Signed-off-by: Amith <amitharun3@gmail.com>

READMEpypi.md

@@ -0,0 +1,99 @@
+# N Perlin Noise
+
+### A robust open source implementation of Perlin Noise Algorithm for N-Dimensions in Python.
+- A powerful and fast API for n-dimensional noise.
+- Easy hyper-parameters selection of octaves, lacunarity and persistence
+  as well as complex and customizable hyper-parameters for n-dimension
+  frequency, waveLength, warp(interpolation) and range.
+- Includes various helpful tools for noise generation and for procedural generation tasks
+  such as customizable Gradient, Warp classes.
+- Implements custom PRNG generator for n-dimension and can be easily tuned.
+
+**Details**:
+- **Technology stack**:
+  - **Status**: [v0.1.2-alpha](https://github.com/Amith225/NPerlinNoise/releases/tag/v0.1.2-alpha)
+  - [CHANGELOG](https://raw.github.com/Amith225/NPerlinNoise/master/docs/CHANGELOG.md)
+
+**Screenshots**:
+- raw
+  - ![raw](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/raw.png)
+- wood
+  - ![wood](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/wood.png)
+- hot nebula
+  - ![hot nebula](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/hot_nebula.png)
+- island
+  - ![island](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/island.png)
+- land
+  - ![land](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/land.png)
+- marble fractal
+  - ![marble fractal](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/marble_fractal.png)
+- patch
+  - ![patch](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/patch.png)
+- ply1
+  - ![ply1](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/ply1.png)
+- ply2
+  - ![ply2](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/ply2.png)
+- stripes
+  - ![stripes](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/stripes.png)
+- warp
+  - ![warp](https://raw.github.com/Amith225/NPerlinNoise/master/snaps/warp.png)
+
+---
+
+## Dependencies
+- Python>=3.10.0
+
+for production dependencies see [Requirements](https://raw.github.com/Amith225/NPerlinNoise/master/requirements.txt)<br>
+for development dependencies see [Dev-Requirements](https://raw.github.com/Amith225/NPerlinNoise/master/requirements_dev.txt)
+
+## Installation
+for detailed instruction on installation see [INSTALLATION](https://raw.github.com/Amith225/NPerlinNoise/master/docs/INSTALL.md).
+
+## Usage
+for detailed usage see [EXAMPLE](https://raw.github.com/Amith225/NPerlinNoise/master/tests/main.py)
+
+## How to test the software
+- To test overalls run [main](https://raw.github.com/Amith225/NPerlinNoise/master/tests/main.py)
+- To test Logical consistency run [testLogic](https://raw.github.com/Amith225/NPerlinNoise/master/tests/testLogic.py)
+- To test Profile Benchmarking run [testProfile](https://raw.github.com/Amith225/NPerlinNoise/master/tests/testProfile.py)
+- To test Visuals run [testVisuals](https://raw.github.com/Amith225/NPerlinNoise/master/tests/testVisuals.py)
+- To test Colors run [testCol](https://raw.github.com/Amith225/NPerlinNoise/master/tests/testCol.py)
+
+to see all tests see [Tests](https://raw.github.com/Amith225/NPerlinNoise/master/tests)
+
+## Known issues
+- **_`No Known Bugs`_**
+- **_`NPerlin.findBounds is bottleneck`_**
+
+## Getting help
+- Check [main.py](https://raw.github.com/Amith225/NPerlinNoise/master/tests/main.py) for detailed usage
+- Check [docs](https://raw.github.com/Amith225/NPerlinNoise/master/docs) for all documentations
+- Check [Usage](#usage) Section
+
+If you have questions, concerns, bug reports, etc,
+please file an [issue](https://github.com/Amith225/NPerlinNoise/issues) in this repository's Issue Tracker or
+open a [discussion](https://github.com/Amith225/NPerlinNoise/discussions/7) in this repository's Discussion section.
+
+
+## Getting involved
+- Looking for Contributors for WebApps
+- [Fork](https://github.com/Amith225/NPerlinNoise/fork) the repository
+  and issue a [PR](https://github.com/Amith225/NPerlinNoise/pulls) to contribute
+
+General instructions on _how_ to contribute  [CONTRIBUTING](https://raw.github.com/Amith225/NPerlinNoise/master/docs/CONTRIBUTING.md).
+
+----
+
+## Open source licensing info
+1. [TERMS](https://raw.github.com/Amith225/NPerlinNoise/master/docs/TERMS.md)
+2. [LICENSE](https://raw.github.com/Amith225/NPerlinNoise/master/LICENSE)
+3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
+
+----
+
+## Credits and references
+1. Inspired from [The Coding Train](https://www.youtube.com/channel/UCvjgXvBlbQiydffZU7m1_aw) -> [perlin noise](https://thecodingtrain.com/challenges/24-perlin-noise-flow-field)
+2. hash function by [xxhash](https://github.com/Cyan4973/xxHash)
+   inspired the [rand3](https://raw.github.com/Amith225/NPerlinNoise/master/src/NPerlinNoise/tools.py) algo
+   and ultimately helped for O(1) time complexity n-dimensional random generator [NPrng](https://raw.github.com/Amith225/NPerlinNoise/master/src/NPerlinNoise/tools.py)
+3. [StackOverflow](https://stackoverflow.com/) for helping on various occasions throughout the development

pyproject.toml

@@ -6,9 +6,9 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "NPerlinNoise"
-version = "0.1.2-alpha"
+version = "0.1.2-alpha4"
 description = "A robust open source implementation of Perlin Noise Algorithm for N-Dimensions"
-readme = "README.pypi.md"
+readme = "READMEpypi.md"
 authors = [{ name = "Amith225", email = "amitharun3@gmail.com" }]
 license = { file = "LICENSE" }
 classifiers = [

readme.py

@@ -1,13 +1,13 @@
 def find_all(a_str, sub, overlap=False):
-    start = 0
+    start_ = 0
     while True:
-        start = a_str.find(sub, start)
-        if start == -1: return
-        yield start
+        start_ = a_str.find(sub, start_)
+        if start_ == -1: return
+        yield start_
         if overlap:
-            start += 1
+            start_ += 1
             continue
-        start += len(sub)
+        start_ += len(sub)
 
 
 with open('README.md', 'r') as file:
@@ -16,7 +16,7 @@ def find_all(a_str, sub, overlap=False):
 _content = ""
 _end = -1
 ignore = ["#usage"]
-base = 'https://github.com/Amith225/NPerlinNoise/tree/master/'
+base = 'https://raw.github.com/Amith225/NPerlinNoise/master/'
 for start, end in zip(find_all(content, '['), find_all(content, ']')):
     _content += content[_end + 1:start]
     end += 1
@@ -27,5 +27,5 @@ def find_all(a_str, sub, overlap=False):
     _content += alt_text + f"({link})"
 _content += content[_end + 1:]
 
-with open('README.pypi.md', 'w+') as file:
+with open('READMEpypi.md', 'w+') as file:
     file.write(_content)