atomicshop 2.16.18

Atomic functions and classes to make developer life easier

Atomic Workshop

About The Project

Atomic Workshop is python's library that was built by Denis Kras under Bugsec's roof.

The main purpose of the library is to simplify the process of developing under python. The library is constantly being improved and supplemented with new features. "Atomic" is a key to basic functions that a developer needs in his daily tasks: create directory, iterate over files, read/write files, manipulate lists, dicts, etc.

There are many gems hidden in the library:

• atomicshop.print_api: this is the main feature of this library. It allows you to print colored text, with different styles, with / without stdout / stderr, RTL text, logger usage. The API will be integrated in every function of the library in the future, so you can easily use it controlling outputs.
• atomicshop.etw.etw: Windows ETW - Event Tracing, a wrapper for FireEye project's ETW library with much easier API. Since, FireEye didn't update their library for quite a while, maybe another solution will be considered in the future. If you have suggestions, please let me know.
• atomicshop.etw.dns_trace: Windows DNS Event Tracing, Traces DNS requests / responses (Event ID: 3008) on Windows OSes that support Event Tracing. Outputs the real domain (not CDN: AWS, GoogleCloud, Azure, etc) with PID. Process Name and Command Line can be retrieved by option.
• atomicshop.sockets: Socket wrapper, can be used to create a server or client and manipulate sockets with relatively easy API. Server tester available.
• atomicshop.mitm: MITM Proxy, allows you to create a TCP proxy server (works with SSL) that will intercept requests and responses. You can modify them, log them, etc. ReadMe to follow. Based on SocketWrapper.
• atomicshop.http_parser: parse HTTP requests and responses to dictionary.
• atomicshop.diff_check.diff_check.DiffChecker: helps on checking if pyhon object, a file or any other thing was updated between checks.
• atomicshop.gitHub_wrapper: easily download branches and latest releases from GitHub repositories.
• atomicshop.archiver: extract archives using options.
• atomicshop.wrappers.configparserw.ConfigParserWrapper: read / write config files to dict, converting string values to other formats (int, bool, list, list_of_ints, etc).
• atomicshop.wrappers.loggingw: wrapper for 'logging' module, allows easier creation and manipulation of the 'logging.Logger' object with enhanced functionality on TimedRotatingFileHandler and formatters.
• atomicshop.wrappers.ffmpegw.FFmpegWrapper: wrapper for FFmpeg, allows you to convert files to other formats. Downloads latest compiled release of ffmpeg from GitHub, if it doesn't find one.
• atomicshop.wrappers.playwrightw: wrapper for Microsoft Playwright, allows you to automate browsers. Has many advanced functions and features, like wait for full page load (wrappers.playwrightw.waits.maximum_idle), that Playwright doesn't have by default.
• atomicshop.sound: this module currently can record sound from Stereo mix to WAV file.
• atomicshop.process: Process wrapper, can be used to get live output from a console process, while it still runs. Execute process in new cmd window, etc.
• atomicshop.scheduling: Scheduler with threads, you can schedule a function to run periodically each 30 minutes (or any specified period of time) using threads (or not).
• atomicshop.timer: measures time passed from the point you start it using python API.
• atomicshop.web.download: File downloader with status.
• atomicshop.file_io: File csv / json / text reader / writer.
• atomicshop.filesystem: functions like, move / create folders, copy / delete files, etc.
• And many more...

Currently, for complete picture you'll have to check the files in the library. I tried my best with understandable naming and grouping convention. Probably in the future docs generated by SPHINX will follow. Currently most of the functions have docstrings with usage and examples.

Most of the functions presented here are atomic, meaning you can use them almost in any project. Also, most of the functions were written firstly to be readable and understandable, and secondly functional. In addition, optimization was a priority. The above meaning that the functions provided are fast and easy to use. Some functions are presented as example of how to do something, to lessen querying to Google, StackOverflow and alike.

Off course, some functions are complete mess in terms of code, speed and probably even logic, but their usefulness outline the cons. And later on, they will be rewritten to be more efficient.

Since, it's a "one man" project, improvements and fixes of existing functions will take time, but you can send me suggestions and pull requests. I will try to respond as soon as time allows. The project is considered pre-pre alpha on heavy features like socket wrapper, but basic functions are stable and can be used in production. Since, it's pre-alpha API names and functionality can change. Follow project's change history for the latest.

I tried my best to use as less external libraries as possible, but some of them are required. Most of them already were added to 'dependencies' section of the setup.

Currently, the library is being developed on Windows 10 and python 3.11. No other platforms or python versions were tested. This means that the official support of the library is mainly for python 3.11 under Windows 10. Most of the features will work, but some require at least version 3.10, like SocketWrapper. Since, some features in it are 3.10 specific.

The library and its features will evolve based on my curiosity and needs. But as of now, the updates to features list are relatively frequent.

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. The easiest way to install the library is to use pip:

   pip install atomicshop
   

2. If you want to use the latest version, you can download or clone the repo:

   git clone https://github.com/BugSec-Official/atomicshop.git
   

   Extract it and install it using pip:

   pip install .
   

   If you're on windows you can use the 'Setup.cmd' provided in the repo.

3. To install the latest version of 'pywintrace' you can use pip:

   pip install https://github.com/fireeye/pywintrace/releases/download/v0.3.0/pywintrace-0.3.0-py3-none-any.whl
   

   The latest version on PyPI is 0.2, so you will need to install from GitHub. Alternatively, you can use a cmd file in the addon folder after 'atomicshop' installation:

   "\Lib\site-packages\atomicshop\addons\a_setup_scripts\install_pywintrace_0.3.cmd"
   

4. If you get an exception while installing the 'psycopg2' package on ubuntu, install this binary:

   sudo apt-get install libpq-dev
   

   Then install the package:

   pip install psycopg2-binary
   pip install psycopg2
   

   Alternatively, you can use a cmd file in the addon folder after 'atomicshop' installation:

   "\Lib\site-packages\atomicshop\addons\a_setup_scripts\install_psycopg2_ubuntu.sh"
   

   Note: 'psycopg2' package is not in prerequisites because of this issue.

Usage

To follow. For now, check the files in the library. I tried my best with understandable naming and grouping convention. There are some ready to use scripts in the 'addons/mains' folder. You can use them as a reference.

License

Distributed under the MIT License. See LICENSE.txt for more information.

History

History.md