Metadata-Version: 2.1
Name: piran
Version: 0.1b0
Summary: "Random" numbers based in pi's decimals
Home-page: https://github.com/Firefnix/PiRan
Author: Firefnix
License: LGPLv3
Project-URL: Bug Reports, https://github.com/Firefnix/PiRan/issues
Project-URL: Source, https://github.com/Firefnix/PiRan
Description: # PiRan: Random numbers based on Pi
        
        ## 1. Disclaimer and license
        ### Disclaimer
        I use the word "random" for the data generated by this library. Thought, all of
        this is **mathematically false**. So do not use this for any serious purpose.
        
        ### License
        GNU LESSER GENERAL PUBLIC LICENSE
            Version 3, 29 June 2007
        
        Copyright (C)  2007 Free Software Foundation, Inc. <https://fsf.org/>
        
        This program is free software; you can redistribute it and/or
        modify it under the terms of the GNU Lesser General Public
        License as published by the Free Software Foundation; either
        version 3 of the License, or (at your option) any later version.
        
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
        Lesser General Public License for more details.
        
        You should have received a copy of the GNU Lesser General Public License
        along with this program; if not, write to the Free Software Foundation,
        Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA, or see
        <https://www.gnu.org/licenses/>.
        
        ## 2. Project overview
          -  Author: Firefnix
          -  Coded in Python 3.8
          -  Licensed under LGPL-3-or-later
          -  Source code: [here][src]
        
        # 3. Usage examples
        To build the digits calculator and compute:
        ```py
        from piran import build, compute
        build() # pi.c -> pi.so
        compute(10000) # Ten thousand digits!
        ```
        Note that this is only needed once. Ten thousand digits are usually computed in
        less than a second.
        Now we can really use the library:
        ```py
        from piran import Random
        r = Random() # Creates a cursor file
        for i in range(10):
            print("unsigned int:", r.uint(10), "\nsigned int:", r.sint(-10, 10))
        
        r.close() # Deletes the cursor file
        ```
        
        # 4. Explanations
        I'm actually not very good at math. But we all know that:
        > Pi is an irrationnal number. Thus, its decimals never repeat themselves.
        
        So I worked on the (mathematically false) assumption that if pi's decimals never
        repeat themselves, then these decimals can be considered "random".
        
        [src]: https://github.com/Firefnix/PiRan
        
Keywords: math pi random
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.5, <4
Description-Content-Type: text/markdown
