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.0.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.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: attnseeker-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 9a8fc30bb4c406ea418372c1be69a55a9e8fe0e50bd88cfb9c1d2c0fd7bfff79
MD5 35d52a95eb6eac4ff1ec2005f1475dd0
BLAKE2b-256 574c5450db9e6c4908731c8cf9b83421510e057b91849e89f30dcb251eecc201

See more details on using hashes here.

File details

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

File metadata

  • Download URL: attnseeker-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2bc7fa307ccb03231e44f5a7658841de8cd1332ac00e899f7f2b06dbef07978
MD5 0d1ac2f847652daec4cde586be10a3c2
BLAKE2b-256 eb915a5a0d63e25586f806ac7c9ef6b480335d1a1414669c86680a3a37ce034c

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