Metadata-Version: 2.1
Name: PyFastConfig
Version: 2.0
Summary: Fast creation and reading of files on Python with configurations.
Home-page: https://github.com/SuperZombi/PyFastConfig
Author: Super_Zombi
Author-email: super.zombi.yt@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# PyFastConfig
Fast creation and reading of files on Python with configurations.

<br/>
Usage example:

<ul>
  <li><a href="#save">Save file</a></li>
  <li><a href="#load">Load file</a></li>
</ul>

```Python
import PyFastConfig as fc
```
<br/>

## Save
```Python
#Declare any values
min_t = 25
max_t = 35
arr = [45, 'hello', 81.5]
```
Quick save:
```Python
fc.save(min_t, max_t, arr)
```
Result file (Config.txt):
```
min_t = int(25)
max_t = int(35)
arr = list([45, 'hello', 81.5])
```

### Optional options:

<table>
  <thead>
  <tr>       <th align="center">Name</th>       <th align="center">Accepts values</th>       <th align="center">Default</th></tr>
  </thead>

  <tr><td>   <code>*args</code></td>            <td>Arguments</td>                             <td>Required</td></tr>
  <tr><td>   <code>file</code></td>             <td>File name</td>                           <td>"config.txt"</td></tr>
  <tr><td>   <code>mode</code></td>             <td>Write modes:<br/>"w" - rewrite<br/>"a" - append</td>        <td>"w"</td></tr>
  <tr><td>   <code>save_types</code></td>       <td>True/False</td>                          <td>True</td></tr>
  <tr><td>   <code>save_names</code></td>       <td>True/False</td>                          <td>True</td></tr>
</table>

```Python
fc.save(*args, file="config.txt", mode="w", save_types=True, save_names=True)
```

<br/>
<br/>

## Load
Quick load:
```Python
#import values (only if run_mode is not False)
#With copy namespace
exec(fc.load("config.txt"))
```
Import inside a function:
```Python
def func():
    exec(fc.load("config.txt", function_mode=True))
```


### Optional options:

<table>
  <thead>
  <tr>       <th align="center">Name</th>       <th align="center">Explanation</th>       <th align="center">Default</th></tr>
  </thead>

  <tr><td>   <code>file</code></td>             <td>File name</td>                           <td>Required</td></tr>
  <tr><td>   <code>run_mode</code></td>         <td>Allows you to run (copy namespace) values<br/>from the library and continue working<br/>with them in the executable.</td>                             <td>True</td></tr>

  <tr><td>   <code>function_mode</code></td>    <td>Does the same as <code>run_mode</code>, but inside a function.</td>   <td>False</td></tr>

  <tr><td>   <code>return_only_names</code></td>             <td>True/False</td>                           <td>False</td></tr>
  <tr><td>   <code>return_only_values</code></td>             <td>True/False</td>        <td>False</td></tr>

</table>

```Python
fc.load(file, run_mode=True, function_mode=False, return_only_names=False, return_only_values=False)
```

If you changed the parameters for saving additional information (<code>save_types</code> and <code>save_names</code>) in the <code>SAVE</code> function, you must disable <code>run_mode</code> when reading such a file.

```Python
#Returns an array (use if you have disabled any of the following options: save_types or save_names)
print(fc.load("config.txt", run_mode=False))
```

