followme


Namefollowme JSON
Version 1.0.1 PyPI version JSON
download
home_pageNone
SummaryA command-line tool to track and report URL redirects
upload_time2025-07-26 21:54:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords url redirect tracking command-line tool
VCS
bugtrack_url
requirements requests colorama
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # FollowMe

A command-line tool to track and report URL redirects. FollowMe helps you understand the complete redirect chain of any URL by following each redirect step-by-step and providing a detailed report.

## Features

- Track complete redirect chains for any URL
- Display status codes for each redirect step with color-coded output
- Save reports to files
- Simple command-line interface
- Cross-platform compatibility
- Colorized terminal output (with option to disable)

## Installation

### From PyPI (recommended)

```bash
pip install followme
```

### From source

```bash
git clone git@github.com:rapidrabbitsoft/followme.git
cd followme
pip install -e .
```

## Usage

### Basic usage

```bash
followme https://example.com
```

This will display the redirect chain for the specified URL.

### Save output to file

```bash
followme https://example.com -o redirect_report.txt
```

### Disable colors

```bash
followme https://example.com --no-color
```

### Examples

```bash
# Check a simple redirect
followme https://bit.ly/example

# Check a URL with multiple redirects
followme https://t.co/example

# Save the report to a file
followme https://example.com -o my_report.txt

# Disable colorized output
followme https://example.com --no-color
```

## Output Format

The tool provides a clear, numbered list of each redirect in the chain with color-coded output:

- **Bold text**: Section headers
- **Cyan**: Original URL
- **Yellow**: Step numbers and redirect status codes (301, 302, 307, 308)
- **Blue**: Source URLs in the redirect chain
- **Magenta**: Destination URLs in the redirect chain
- **Green**: Final status codes (200) and "(final)" indicator
- **Red**: Error status codes

```
Redirect chain for https://example.com:
1. https://example.com --[301]--> https://www.example.com
2. https://www.example.com --[200]--> (final)
```

You can disable colors using the `--no-color` flag.

## Requirements

- Python 3.7 or higher
- requests library
- colorama (optional, for Windows color support)

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## Issues

If you encounter any issues, please report them on the GitHub issue tracker. 

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "followme",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Chris McMichael <python@apprabb.it>",
    "keywords": "url, redirect, tracking, command-line, tool",
    "author": null,
    "author_email": "Rapid Rabbit Software <python@rapidrabbit.software>",
    "download_url": "https://files.pythonhosted.org/packages/4b/9f/48fa4217271ef7785d7211e7bda58cb595077d15bbdde6ec0d36708472c2/followme-1.0.1.tar.gz",
    "platform": null,
    "description": "# FollowMe\n\nA command-line tool to track and report URL redirects. FollowMe helps you understand the complete redirect chain of any URL by following each redirect step-by-step and providing a detailed report.\n\n## Features\n\n- Track complete redirect chains for any URL\n- Display status codes for each redirect step with color-coded output\n- Save reports to files\n- Simple command-line interface\n- Cross-platform compatibility\n- Colorized terminal output (with option to disable)\n\n## Installation\n\n### From PyPI (recommended)\n\n```bash\npip install followme\n```\n\n### From source\n\n```bash\ngit clone git@github.com:rapidrabbitsoft/followme.git\ncd followme\npip install -e .\n```\n\n## Usage\n\n### Basic usage\n\n```bash\nfollowme https://example.com\n```\n\nThis will display the redirect chain for the specified URL.\n\n### Save output to file\n\n```bash\nfollowme https://example.com -o redirect_report.txt\n```\n\n### Disable colors\n\n```bash\nfollowme https://example.com --no-color\n```\n\n### Examples\n\n```bash\n# Check a simple redirect\nfollowme https://bit.ly/example\n\n# Check a URL with multiple redirects\nfollowme https://t.co/example\n\n# Save the report to a file\nfollowme https://example.com -o my_report.txt\n\n# Disable colorized output\nfollowme https://example.com --no-color\n```\n\n## Output Format\n\nThe tool provides a clear, numbered list of each redirect in the chain with color-coded output:\n\n- **Bold text**: Section headers\n- **Cyan**: Original URL\n- **Yellow**: Step numbers and redirect status codes (301, 302, 307, 308)\n- **Blue**: Source URLs in the redirect chain\n- **Magenta**: Destination URLs in the redirect chain\n- **Green**: Final status codes (200) and \"(final)\" indicator\n- **Red**: Error status codes\n\n```\nRedirect chain for https://example.com:\n1. https://example.com --[301]--> https://www.example.com\n2. https://www.example.com --[200]--> (final)\n```\n\nYou can disable colors using the `--no-color` flag.\n\n## Requirements\n\n- Python 3.7 or higher\n- requests library\n- colorama (optional, for Windows color support)\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## Issues\n\nIf you encounter any issues, please report them on the GitHub issue tracker. \n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A command-line tool to track and report URL redirects",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/rapidrabbitsoft/followme",
        "Issues": "https://github.com/rapidrabbitsoft/followme/issues",
        "Repository": "https://github.com/rapidrabbitsoft/followme"
    },
    "split_keywords": [
        "url",
        " redirect",
        " tracking",
        " command-line",
        " tool"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "72fc9e0d7c8cd44b899171927054c50b4ddb0ab2237d42d7dcadfd6935b1453e",
                "md5": "ec5be575615e2029f3f8df1b3b3316e5",
                "sha256": "aff061e035046367fade2f26db6ebb23f08fd6fae06d5c4b639bb4cd681f6e1c"
            },
            "downloads": -1,
            "filename": "followme-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ec5be575615e2029f3f8df1b3b3316e5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 6237,
            "upload_time": "2025-07-26T21:54:38",
            "upload_time_iso_8601": "2025-07-26T21:54:38.906960Z",
            "url": "https://files.pythonhosted.org/packages/72/fc/9e0d7c8cd44b899171927054c50b4ddb0ab2237d42d7dcadfd6935b1453e/followme-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4b9f48fa4217271ef7785d7211e7bda58cb595077d15bbdde6ec0d36708472c2",
                "md5": "870bceb57cc1adbf959ca38e61b48cbe",
                "sha256": "934e4ac909ce33ab54e75dca3b10d61e137009c3af2663a130b14b896150131e"
            },
            "downloads": -1,
            "filename": "followme-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "870bceb57cc1adbf959ca38e61b48cbe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 5536,
            "upload_time": "2025-07-26T21:54:39",
            "upload_time_iso_8601": "2025-07-26T21:54:39.760804Z",
            "url": "https://files.pythonhosted.org/packages/4b/9f/48fa4217271ef7785d7211e7bda58cb595077d15bbdde6ec0d36708472c2/followme-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-26 21:54:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rapidrabbitsoft",
    "github_project": "followme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "requests",
            "specs": [
                [
                    ">=",
                    "2.25.0"
                ]
            ]
        },
        {
            "name": "colorama",
            "specs": [
                [
                    ">=",
                    "0.4.0"
                ]
            ]
        }
    ],
    "lcname": "followme"
}
        
Elapsed time: 1.28252s