Skip to content

Commit

Permalink
Updated readme and removed auto added dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
adalfarus committed Jun 20, 2024
1 parent c7eb72b commit 38911e4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 42 deletions.
63 changes: 23 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ aplustools is a simple, user-friendly Python library for performing amazing task
You can install aplustools via pip:

```sh
pip install aplustools --upgrade
pip install aplustools[all] --upgrade
```

Or clone the repository and install manually:
Expand All @@ -28,7 +28,6 @@ Or clone the repository and install manually:
git clone https://github.com/Adalfarus/aplustools.git
cd aplustools
python -m build
```

## Usage

Expand Down Expand Up @@ -170,56 +169,25 @@ generator = SecurePasswordGenerator("strong")
secure_password = generator.generate_secure_password()
print(f"Secure password {secure_password}")
````

(If you want to ensure that all dependencies are installed please run `upype import aplustools; aplustools.install_all_dependencies()`)
(Correct shortform for aplustools is apt, so please use ```import aplustools as apt``` for consistency)

There are multiple clis added through this package:

### pype (python pipe)
```bash
C:\Users\user_>pype
Enter Python expression: 1 + 2
3

C:\Users\user_>pype 1 // 3
0
```
### upype (unified python pipe)
```bash
C:\Users\user_>upype import aplustools; print(aplustools.__version__)
1.4.4

C:\Users\user_>upype
Enter Python code (type 'end' on a new line to finish):
... class Test:
... def hello_word(self):
... print("Hello, you!")
... test = Test()
... test.hello_word()
... end
Hello, you!
```
These can also be used in e.g. batch files like this
You can use the password generators like this in e.g. batch scripts:
```batch
@echo off
set /p id=Enter ID:
upype from aplustools.security.passwords import QuickGeneratePasswords; print(QuickGeneratePasswords.generate_sentence_based_password("""%id%"""))
python -c "from aplustools.security.passwords import SecurePasswordGenerator; pw = SecurePasswordGenerator(""strong"").generate_secure_password(); print(f""{pw[""password""]}\n{pw[""extra_info""]} -> {pw[""worst_case""]}"")"
pause
```
or like this
````batch
@echo off
set /p id=Enter ID:
upype from aplustools.security.passwords import PasswordGenerator; print(PasswordGenerator().generate_sentence_based_password_v3("""%id%""", random_case=True, extra_char="""_""", char_position=0, num_length=5, special_chars_length=2))
python -c "from aplustools.security.passwords import SpecificPasswordGenerator; print(SpecificPasswordGenerator().generate_sentence_based_password_v3("""%id%""", random_case=True, extra_char="""_""", char_position=0, num_length=5, special_chars_length=2))"
pause
````
### apt
Can currently run tests with ```apt tests run``` and show a basic help using ```apt help```.
(If you have problems with the package please use `py -3.12 -m pip install aplustools[all] --upgrade --user`)
(Correct shortform for aplustools is apt, so please use ```import aplustools as apt``` for consistency)
### apt cli
Can currently run tests with ```apt tests run``` and show a basic help using ```apt help```.
For more detailed usage and examples, check out our [documentation](https://github.com/adalfarus/aplustools/wiki).
Expand Down Expand Up @@ -264,6 +232,21 @@ We welcome contributions! Please see our [contributing guidelines](https://githu
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a pull request
### Apt Build master
You can use the apt_build_master script for your os to make your like a lot easier.
It supports running tests, installing, building and much more as well as chain together as many commands as you like.
This example runs test, build the project and then installs it
````commandline
call .\apt_build_master.bat 134
````
````shell
chmod +x ./apt_build_master.sh
./apt_build_master.sh 134
````
## License
aplustools is licensed under the LGPL-2.1 License - see the [LICENSE](https://github.com/adalfarus/aplustools/blob/main/LICENSE) file for details.
2 changes: 0 additions & 2 deletions src/aplustools/package/timid.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
from typing import (Callable as _Callable, Union as _Union, List as _List, Tuple as _Tuple, Optional as _Optional,
Type as _Type, Iterable as _Iterable, Any as _Any, Generator as _Generator, Literal as _Literal)

from openpyxl.worksheet.scenario import ScenarioList
from sklearn.linear_model import RANSACRegressor as _RANSACRegressor
from datetime import timedelta as _timedelta, datetime as _datetime
from scipy.optimize import curve_fit as _curve_fit
Expand Down

0 comments on commit 38911e4

Please sign in to comment.