Skip to content

Commit fda1b76

Browse files
committed
updated to v0.0.15 to remove a file
1 parent 866a18e commit fda1b76

25 files changed

Lines changed: 48 additions & 41318 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ __pycache__
33
temp/*
44
venv_*
55
.env
6+
app/ctfsolver/find_usage/gathering.py

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.0.14
1+
0.0.15

app/ctfsolver.egg-info/PKG-INFO

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Metadata-Version: 2.4
22
Name: ctfsolver
3-
Version: 0.0.14
3+
Version: 0.0.15
44
Summary: An all in one library for solving CTF challenges
55
Author: Nikolas Filippatos
66
License: MIT
@@ -49,33 +49,65 @@ Dynamic: license-file
4949

5050
CTFSolverScript is a tool designed to assist in solving Capture The Flag (CTF) challenges. It provides utilities and scripts to streamline the process of solving various types of CTF problems.
5151

52+
This library has been created to suit my needs.
53+
54+
What I mean is, I was developing it when I was solving CTF challenges.
55+
By solving the ctf's with python, and automating the solutions, I collected many scripts.
56+
57+
Some functionalities came by request, some I implemented out of personal interest.
58+
59+
Some things will seem weird to others, such as the structure of the challenge folder, and the keywords used.
60+
61+
The documentation is still under development.
62+
5263
## Features
5364

5465
- **Automated Scripts**: Pre-built scripts for common CTF tasks.
5566
- **Modular Design**: Easily extendable to add custom scripts.
5667
- **Cross-Platform**: Works on Linux, macOS, and Windows.
57-
- **Lightweight**: Minimal dependencies for quick setup.
5868

5969
## Installation
6070

61-
[official pypi link](https://pypi.org/project/ctfsolver)
71+
[installation instructions can be found here.](docs/sphinx/source/modules/installation.md)
72+
73+
## Usage
74+
75+
Can be used as a class for scripting and as a cli tool
6276

6377
```bash
64-
pip install ctfsolver
78+
ctfsolver --help
6579
```
6680

67-
## Usage
81+
```
82+
ctfsolver help
83+
```
84+
85+
[detailed usage instructions can be found here.](docs/sphinx/source/modules/usage.md)
86+
87+
[Automated Documentation can be found here.](https://nikolasfil.github.io/CTFSolverScript/)
88+
89+
When the repo is cloned locally you can find pdoc and sphinx generated documentation in the docs/ folder.
90+
91+
```bash
92+
make doc-pdoc-host
93+
```
94+
95+
```bash
96+
make doc-sphinx-host
97+
```
98+
99+
## Contributing
68100

69-
Either as a class or as a command-line tool.
70-
More documentation on the way.
71-
For now the documentation is autogenerated from docstrings using pdoc3
101+
Contributions are welcome! Please follow these steps:
72102

73-
[ctfsolver](https://nikolasfil.github.io/CTFSolverScript/ctfsolver/)
103+
1. Fork the repository.
104+
2. Create a new branch for your feature or bugfix.
105+
3. Submit a pull request with a detailed description of your changes.
74106

75107
## License
76108

77109
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
78110

79111
## Contact
80112

81-
Feel free to open a ticket on the [GitHub Issues page](https://github.com/nikolasfil/CTFSolverScript/issues) for any questions or suggestions.
113+
For questions or suggestions, feel free to open an issue or contact the maintainer at `filippatos.nikolas@gmail.com`.

app/ctfsolver.egg-info/SOURCES.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ app/ctfsolver/feature_test/testing_files.py
2929
app/ctfsolver/find_usage/__init__.py
3030
app/ctfsolver/find_usage/__main__.py
3131
app/ctfsolver/find_usage/function_definition_class.py
32-
app/ctfsolver/find_usage/gathering.py
3332
app/ctfsolver/find_usage/manager_gathering.py
3433
app/ctfsolver/folders/__init__.py
3534
app/ctfsolver/folders/__main__.py

0 commit comments

Comments
 (0)