Merge branch 'dev-sadra' into github-actions

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at info@4r7.ir. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contribution			
+
+Changes and improvements are more than welcome! ❤️ Feel free to fork and open a pull request.
+
+Please consider the following :
+
+1. Fork it!
+2. Create your feature branch (under `dev` branch)
+3. Add your new features or fix detected bugs
+4. Add standard `docstring` to your functions
+5. Update `README.md` (if needed)
+6. Pass all CI tests
+7. Update `CHANGELOG.md`
+	- Describe changes under `[Unreleased]` section
+8. Update `AUTHORS.md`
+	- Add your name under `# Other Contributors #` section
+9. Submit a pull request into `dev` (please complete the pull request template)
+

samila/functions.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """Samila functions."""
 
-from .params import Projection, DEFAULT_PROJECTION
+from .params import Projection, DEFAULT_PROJECTION, VALID_COLORS
 
 def float_range(start, stop, step):
     """
@@ -61,7 +61,6 @@ def filter_color(color):
     if isinstance(color, tuple):
         return color
     if isinstance(color, str):
-        from .params import VALID_COLORS
         distance_list = list(map(lambda x: distance_calc(color, x),
                                  VALID_COLORS))
         min_distance = min(distance_list)

samila/genimage.py

@@ -8,8 +8,24 @@ from .params import *
 
 
 class GenerativeImage:
+    """
+    Generative Image class.
 
+    >>> def f1(x, y):
+    ...    return random.uniform(-1, 1) * x**2 - math.sin(y**3)
+    >>> def f2(x, y):
+    ...    return random.uniform(-1, 1) * y**3 - math.cos(x**2)
+    >>> GI = GenerativeImage(f1, f2)
+    """
     def __init__(self, function1, function2):
+        """
+        Init method.
+
+        :param function1: Function 1
+        :type function1: python or lambda function
+        :param function2: Function 2
+        :type function2: python or lambda function
+        """
         self.function1 = function1
         self.function2 = function2