MarkupPy 1.18
An HTML/XML generator
License: MIT
Requires Python: >=2.7

## MarkupPy
This is MarkupPy - a Python module that attempts to make it easier to generate HTML/XML from a Python program in an intuitive, lightweight, customizable and pythonic way. It works with both python 2 and 3.

<b>Installation:</b>
    
    pip install MarkupPy

Documentation and further info is at https://tylerbakke.github.io/MarkupPy/

Please send bug reports, feature requests, enhancement ideas or questions to tylerbakke@gmail.com.

The Python Package can be found at https://pypi.python.org/pypi/MarkupPy.

The code is in the public domain. Version: 1.17 as of March 12 2024.

## Usage Examples

### Basic Example

```python
from MarkupPy import markup

# Create an HTML page
page = markup.page()
page.init(title="My Title")
page.p("Hello, World!")
page.p.close()

# Print the HTML
print(page)
```

### Inline Styles and Scripts (v1.16+)

You can now add inline CSS and JavaScript directly in the `init` method:

```python
page = markup.page()
page.init(
    title="My Styled Page",
    style_content="body { background-color: #f0f0f0; } h1 { color: blue; }",
    script_content="function greet() { alert('Hello!'); }"
)
```

You can also pass multiple styles/scripts as a list:

```python
page.init(
    title="My Styled Page",
    style_content=[
        "body { background-color: #f0f0f0; }",
        "h1 { color: blue; }"
    ],
    script_content=[
        "function greet() { alert('Hello!'); }",
        "function goodbye() { alert('Goodbye!'); }"
    ]
)
```

### Avoiding Extra Newlines in Pre Tags (v1.17+)

When adding content to `<pre>` elements, you might want to avoid extra newlines. The `add_raw` method helps with this:

```python
page = markup.page()
page.init()
page.pre.open()

# Standard add method (inserts extra newlines between each addition)
page.add("Line 1")
page.add("Line 2")  # This will create extra space between lines

# Better approach with add_raw (no extra newlines)
page.add_raw("Line 3\n")
page.add_raw("Line 4\n")  # Only the explicit newlines are included

page.pre.close()
```

For pre-formatted text with tables or code samples, `add_raw` preserves the exact formatting you specify.

## Running Tests

The package includes tests for all features. To run the tests:

```bash
# Navigate to the MarkupPy directory
cd MarkupPy

# Run all tests
python tests/run_tests.py

# Run specific test modules
python tests/test_inline_features.py
python tests/test_add_raw.py
```

The tests verify that:
1. Inline styles and scripts work correctly in the `init` method
2. The `add_raw` method properly handles pre-formatted content without adding unwanted newlines

## For Maintainers

### Release Process

When publishing a new release to PyPI, follow these steps:

1. Update the version number in both:
   - `MarkupPy/markup.py` (update `__version__` and `__date__`)
   - `pyproject.toml` (update `version` under `[project]`)

2. Add a Git tag for the release:
   ```bash
   git tag -a v1.XX -m "Version 1.XX - Brief description of changes"
   git push origin v1.XX
   ```

3. Build and upload to PyPI:
   ```bash
   python -m build
   python -m twine upload dist/markuppy-1.XX*
   ```

Tagging each PyPI release in the Git repository makes it easier to track releases and find specific versions of code.

### Automated Release Process

The project uses GitHub Actions for automated releases. There are two ways to trigger a release:

#### Automatic Release on Version Bump

1. Update the version number in both:
   - `MarkupPy/markup.py` (update `__version__` and `__date__`)
   - `pyproject.toml` (update `version` under `[project]`)

2. Commit and push the changes to GitHub:
   ```bash
   git add MarkupPy/markup.py pyproject.toml
   git commit -m "Bump version to X.XX"
   git push origin main
   ```

The workflow will automatically:
- Detect the version change
- Verify that the version numbers match
- Create a Git tag
- Build the package
- Publish to PyPI using trusted publishing

#### Manual Release

If you need to run the release process manually:

1. Go to the GitHub repository, click on "Actions" tab
2. Select the "Build and Publish" workflow
3. Click "Run workflow"
   - Enter the version number (e.g., 1.18)
   - Enable the "Create git tag" option if you want to automatically tag the release
   - Click "Run workflow"

The workflow will perform the same steps as the automatic release process.

This automated process helps ensure consistency and reduces manual steps in the release process.