|
1 | 1 | Metadata-Version: 2.4 |
2 | 2 | Name: ctfsolver |
3 | | -Version: 0.0.14 |
| 3 | +Version: 0.0.15 |
4 | 4 | Summary: An all in one library for solving CTF challenges |
5 | 5 | Author: Nikolas Filippatos |
6 | 6 | License: MIT |
@@ -49,33 +49,65 @@ Dynamic: license-file |
49 | 49 |
|
50 | 50 | 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. |
51 | 51 |
|
| 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 | + |
52 | 63 | ## Features |
53 | 64 |
|
54 | 65 | - **Automated Scripts**: Pre-built scripts for common CTF tasks. |
55 | 66 | - **Modular Design**: Easily extendable to add custom scripts. |
56 | 67 | - **Cross-Platform**: Works on Linux, macOS, and Windows. |
57 | | -- **Lightweight**: Minimal dependencies for quick setup. |
58 | 68 |
|
59 | 69 | ## Installation |
60 | 70 |
|
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 |
62 | 76 |
|
63 | 77 | ```bash |
64 | | -pip install ctfsolver |
| 78 | +ctfsolver --help |
65 | 79 | ``` |
66 | 80 |
|
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 |
68 | 100 |
|
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: |
72 | 102 |
|
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. |
74 | 106 |
|
75 | 107 | ## License |
76 | 108 |
|
77 | 109 | This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |
78 | 110 |
|
79 | 111 | ## Contact |
80 | 112 |
|
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`. |
0 commit comments