first

.gitignore

@@ -0,0 +1,4 @@
+pyenv
+__pycache__/
+.ruff_cache
+.vscode

CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+- Initial release

CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing Guidelines
+
+Contributions are always welcome!
+
+**Before spending lots of time on something, ask for feedback on your idea first!**
+
+Please search issues and pull requests before adding something new to avoid duplicating
+efforts and conversations.
+
+
+To make a code contribution to srt2docx
+--------------------------------------
+
+* Fork the srt2docx Github repository and make your changes.  Use a well named topic branch for the changes, preferably with uppercase and dashes, use your initials at the beginning of the branch name e.g. `SD-SRT2DOCX-FIXES`.  Fork off the `master` branch.  Avoid forking from repository work branches as they may get rebased.
+
+* Test your changes as thoroughly as possible, by running the test suite and viewing the coverage reports.
+
+* Please follow the code style for the language you are working in and try to match the general structure of the code.  Check that your diff looks as clean and minimal as possible.
+
+* Create a pull request in Github.  For now, the "base branch" should be
+  "master", i.e. the pull requests are merged directly to the master branch.
+  In the description:
+
+  - Summarize the change and the motivation for the change.
+
+  To report bugs or request features
+----------------------------------
+
+Use GitHub issues to report bugs or request features:
+
+* Please include a compilation or execution log to help diagnosis.
+
+
+## Installing
+
+Fork and clone the repo, then build and run tests to ensure all is okay before you start anything.
+
+
+## Testing
+
+Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem).
+

LICENSE.md

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) 2024 DreamOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

Makefile

@@ -0,0 +1,15 @@
+setup:
+	@python -m venv pyenv; \
+	source ./pyenv/bin/activate; \
+	pip install -r requirements.txt; \
+	echo activate env with: source ./source-me
+requirements:
+	@pip freeze > requirements.txt
+lint:
+	@ruff check .
+fix:
+	@ruff check . --fix
+format:
+	@ruff format .
+git-show:
+	@git log --graph --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%an%C(reset)%C(bold yellow)%d%C(reset) %C(dim white)- %s%C(reset)' --all

README.md

@@ -0,0 +1,32 @@
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/ScottDillman/srt2docx">
+    <img src="assets/logo_header.png" alt="Logo" width=300">
+  </a>
+  <p align="center"><img src="assets/flour006.png" alt="smile" width=250"></p>
+  <h3 align="center">srt2docx</h3>
+</p>
+
+Convert srt files to tables in docx
+
+This assumes you have a bash environment.
+
+### Installation
+- Run `make setup`, to initialise environment and create the vitual python environment
+- Source the init script `source source-me`, to activate the python environment
+
+### Running
+- Change settings in `srt2docx_settings.yaml` to your preferences
+- Go to directory with input files
+- execute the script `srt2docx` with the full path, or if you source the `source-me` file it will get added to your path and you can just use `srt2docx` without the path.
+
+### Watermarks
+If you want to use or change the watermark, put the file in the assets directory, and put the file name in the yaml.
+The script will look in the assets directory for all images.
+
+After a sucessful run you should have docx files that share the same base name with the input files except with a `.docx` extension. Errors should be reported to std out.
+
+>Any questions or comments [Scott Dillman](mailto:[email protected])
+
+Licensed under MIT.

SECURITY.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If there are any vulnerabilities in srt2docx, don't hesitate to _report them_.
+
+1. Use any of the [private contact addresses](https://github.com/ScottDillman/srt2docx#support).
+2. Describe the vulnerability.
+
+- If you have a fix, explain or attach it.
+- In the near time, expect a reply with the required steps. Also, there may be a demand for a pull request which include the fixes.
+
+> You should not disclose the vulnerability publicly if you haven't received an answer in some weeks.
+> If the vulnerability is rejected, you may post it publicly within some hour of rejection, unless the rejection is withdrawn within that time period.
+> After the vulnerability has been fixed, you may disclose the vulnerability details publicly over some days.