Skip to main content

A Python package for attention-seeking functionality

Project description

AttnSeeker

A Python package for attention-seeking functionality.

Features

  • Core attention-seeking functionality
  • Command-line interface
  • Extensible architecture
  • Comprehensive testing

Installation

You can install the package from PyPI:

pip install attnseeker

Or install from source:

git clone https://github.com/yourusername/attnseeker.git
cd attnseeker
pip install -e .

Usage

Basic Usage

from attnseeker import main_function
from attnseeker import AttnSeeker

# Use the main function
result = main_function()
print(result)  # "Hello from attnseeker!"

# Create an AttnSeeker instance
seeker = AttnSeeker("World")
greeting = seeker.greet()
print(greeting)  # "Hello, World! I'm seeking attention!"

Command Line Interface

The package also provides a command-line interface:

attnseeker --help
attnseeker --name "Alice"
attnseeker --verbose

Development

Setup Development Environment

  1. Clone the repository:

    git clone https://github.com/yourusername/attnseeker.git
    cd attnseeker
    
  2. Create a virtual environment:

    python -m venv .venv
    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
    
  3. Install development dependencies:

    pip install -e ".[dev]"
    
  4. Install pre-commit hooks:

    pre-commit install
    

Running Tests

pytest

Code Formatting

The project uses Black for code formatting and isort for import sorting:

black src/ tests/
isort src/ tests/

Type Checking

mypy src/

Linting

flake8 src/ tests/

Building and Publishing

Build the Package

python -m build

Upload to PyPI

First, install the build tools:

pip install build twine

Then build and upload:

# Build the package
python -m build

# Upload to TestPyPI (for testing)
twine upload --repository testpypi dist/*

# Upload to PyPI (for production)
twine upload dist/*

Publishing Strategy

This project uses a multi-package strategy to reserve related names:

  1. attnseeker - Main package with full functionality
  2. attentionseeker - Placeholder package that redirects to attnseeker
  3. attention-seeker - Placeholder package that redirects to attnseeker

This ensures that all related package names are reserved and users are directed to the main package.

Using GitHub Actions

This repository includes GitHub Actions workflows for:

  • Running tests on multiple Python versions
  • Code quality checks
  • Automatic releases to PyPI

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

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

Changelog

[0.1.0] - 2024-01-01

  • Initial release
  • Basic attention-seeking functionality
  • Command-line interface
  • Placeholder packages for name reservation

Acknowledgments

  • Thanks to all contributors
  • Inspired by attention-seeking behavior patterns

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

attnseeker-0.1.1.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

attnseeker-0.1.1-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file attnseeker-0.1.1.tar.gz.

File metadata

  • Download URL: attnseeker-0.1.1.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for attnseeker-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8d76f7818216712d4d27e2a75c74cef22def482db608ab19636ee505c5727597
MD5 6d020087a04898c0e326c7058c58da6c
BLAKE2b-256 8b3e36afc8a1abb597129829b5a12f01c84daa2fe027d87b5832157b85b53e3e

See more details on using hashes here.

File details

Details for the file attnseeker-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: attnseeker-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for attnseeker-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d0a285901f29825a844684bbef6d4777c8e49c6107ba7b6e403591b1293beca4
MD5 3e84e7fc6c266721461c7e27d789c2ff
BLAKE2b-256 7eba4933a668926bc7b964951150dd4634e07e709e723bed6164db4a243d437c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page