Metadata-Version: 2.1
Name: EasyGA
Version: 0.0.10
Summary: A ubiquitous or general purpuse GA
Home-page: https://github.com/danielwilczak101/EasyGA
Author: Daniel Wilczak
Author-email: danielwilczak101@gmail.com
License: UNKNOWN
Description: # EasyGA - A general solution to Genetic Algorithms
        
        Project description
        
        ## Installation:
        
        Run the rolling to install:
        
        ```Python
        pip3 install EasyGA
        ```
        
        ## Getting started with EasyGA:
        ```Python
        import EasyGA
        
        # Setup the default genetic algorithm
        ga = EasyGA.GA()
        # Run the default genetic algorithm
        ga.evolve()
        ```
        
        ### Output:
        ```python
        Put the out here
        ```
        
        
        
        # How Testing works
        
        ### Getting started with testing
        
        ```bash
        pip3 install pytest
        ```
        
        ### Navigate to your EasyGA folder and run:
        ```bash
        pytest
        ```
        
        #### Output
        ```bash
        ============================== 1 passed in 0.02s ===============================
        danielwilczak@Daniels-MacBook-Pro EasyGA % pytest
        ============================= test session starts ==============================
        platform darwin -- Python 3.8.6rc1, pytest-6.0.2, py-1.9.0, pluggy-0.13.1
        rootdir: /Users/danielwilczak/github/EasyGA
        collected 1 item                                                               
        
        src/gene/test_gene.py .                                                  [100%]
        
        ============================== 1 passed in 0.03s ===============================  
        
        ```
        
        This is only an example and we will create hundreds of tests so this list will become bigger and bigger.
        
        
        ## Developing EasyGA:
        ### If you know how to use Github and git ignore this section.
        
        ### Getting started with development
        To work together we plan on using github and the git framework. This is made easy with the Atom software.
        
        Download Atom for whatever OS you have.
        https://atom.io/
        
        Use the github tab to pull the github repository. Its self explanitory.
        
        Use the <b>run_testing.py</b> file inside the src folder to run your code and test while we build the package.
        
        ## Other options
        
        Download the repository to some folder - If you never used git. Look up a youtube tutorial. It will all make sense.
        ```
        git clone https://github.com/danielwilczak101/EasyGA.git
        ```
        Or download as a zip file.
        ```
        https://github.com/danielwilczak101/EasyGA/archive/master.zip
        ```
        Use the example.py file inside the src folder to run your code and test while we build the package.
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
