URL Opener

Table of Contents

• URL Opener
  • Table of Contents
  • About the project
    • How it works
    • Content overview
  • Getting started
    • Prerequisites and example usage
    • Running tests
  • Versioning
    • Using git as a version control system
  • Resources used to create this project
  • License
  • Copyright

About the project

A command-line tool that allows users to open multiple websites simultaneously, each in a separate tab in Firefox. It reads URLs from an XML file and opens them based on the specified segment.

How it works

When the program is executed, it reads the structure of the data.xml file. The script must be called with a parameter that matches one of the tags a step below the root tags in the hierarchy. This parameter identifies the correct section of the file. The script then iterates over all <url> tags within that section and opens each URL in a new Firefox browser tab.

Content overview

.
├── data/ - data directory with urls
├── tests/ - unit and regression tests
├── __init__.py - package initialization
├── .bumbversion.cfg - automatically process version
├── .gitignore - excludes unnecessary files
├── COPYRIGHT - project copyright
├── LICENSE - license text
├── README.md - project information
├── requirements.txt - project requirements
└── open_url.py - main program

Getting started

Prerequisites and example usage

0. Clone the repository:

git clone https://github.com/CH6832/online-resources-to-stay-updated.git

1. Navigate into the folder:

cd online-resources-to-stay-updated

2. Install requirements:

pip3 install -r requirements.txt

3. Examples with the required parameters:

py url_opener.py websites

py url_opener.py articles

Running tests

pytest test_url_launcher.py

Versioning

The project uses Semantic Versioning to manage versions. Semantic Versioning follows the format MAJOR.MINOR.PATCH, where:

• MAJOR version increments indicate incompatible changes or major updates.
• MINOR version increments indicate new features or improvements that are backward-compatible.
• PATCH version increments indicate backward-compatible bug fixes.

Versioning Example

• 1.0.0: Initial release with basic functionality.
• 1.1.0: Added new features like tab completion and command aliases.
• 1.1.1: Fixed bugs and improved error handling.

To see the current version of the project, check the version attribute in the script or refer to the version tags in the Git repository.

Using git as a version control system

0. Initialize a Git Repository:

git init

1. Add and Commit Changes

git add .
git commit -m "Initial commit"

2. Tagging releases

git tag -a v1.0.0 -m "Initial release"

3. Pushing to remote repo

git remote add origin https://github.com/CH6832/online-resources-to-stay-updated.git
git push origin main --tags

Resources used to create this project

• Python
  • Python 3.12 documentation
  • Built-in Functions
  • Python Module Index
  • pytest: helps you write better programs
  • pylint
  • mypy
  • xml.etree.ElementTree
• XML
  • Extensible Markup Language (XML) 1.0 (Fifth Edition)
  • W3C XML Schema Definition Language (XSD)
• Markdwon
  • Basic syntax
  • Complete list of github markdown emojis
  • Awesome template
  • .gitignore file
• Editor
  • Visual Studio Code
• Commandline tools
  • Build Command-Line Interfaces With Python's argparse
  • Master the Art of Command Line: Your Ultimate Guide to Developing Powerful Tools
  • Command Line Interface Guidelines
  • Building a Network Command Line Interface in Go

License

This project is licensed under the terms of the GPL v3.

Copyright

See the COPYRIGHT file for copyright and licensing details.