| Name | arch-reggie JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A package for checking professional registration status across various certification bodies |
| upload_time | 2025-07-09 07:35:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
bvn
nsw
qld
architecture
registration
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Arch Reggie
A Python package for checking professional registration status across various certification bodies, particularly useful for architecture.
It can check the NSW and QLD ARBs at the moment, but there's potential to add more in the future.
## Installation
```bash
pip install arch-reggie
```
## Quick Start
```python
from reggie import RegistrationProcessor, ProcessingConfig
# Initialize with default configuration (works with standard CSV format)
processor = RegistrationProcessor()
# Process a CSV file - default expects columns: Email, Full Name, LinkedIn URL, State Board Name, Registration Number, State Board Code
results = processor.process_csv("path/to/your/registrations.csv")
# Save results as JSON
processor.save_json(results, "output.json")
```
## CSV Format
The default configuration expects a headerless CSV with these columns in order:
1. Email
2. Full Name
3. LinkedIn URL
4. State Board Name (e.g., "NSW Architects Registration Board")
5. Registration Number
6. State Board Code (e.g., "NSW", "QLD")
## Supported Registration Bodies
- NSW Architects Registration Board
- Board of Architects of Queensland
- ~Northern Territory Architects Board~ not yet
- ~Architects Registration Board of Victoria~ not yet
- ~Registered Design Practitioner NSW~ not yet
## Configuration
The package works out-of-the-box with the standard CSV format, but supports custom configuration:
```python
from reggie import RegistrationProcessor, ProcessingConfig
# For different CSV formats, customize the configuration
config = ProcessingConfig(
# If your CSV has different column names:
column_names=["email", "name", "linkedin", "body", "number", "state"],
email_column="email",
full_name_column="name",
# Processing options:
check_registrations=True, # Set to False to skip web scraping
selenium_headless=True, # Set to False to see browser window
output_format="json"
)
processor = RegistrationProcessor(config=config)
```
## Development
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
## License
MIT License - see [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "arch-reggie",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "BVN, NSW, QLD, architecture, registration",
"author": null,
"author_email": "Ben Doherty <ben_doherty@bvn.com.au>",
"download_url": "https://files.pythonhosted.org/packages/e0/39/fabc293d18044d5412c58e357a66170c4296329f1ac7cff3c270d61f93b4/arch_reggie-0.1.0.tar.gz",
"platform": null,
"description": "# Arch Reggie\n\nA Python package for checking professional registration status across various certification bodies, particularly useful for architecture.\n\nIt can check the NSW and QLD ARBs at the moment, but there's potential to add more in the future.\n\n\n\n## Installation\n\n```bash\npip install arch-reggie\n```\n\n## Quick Start\n\n```python\nfrom reggie import RegistrationProcessor, ProcessingConfig\n\n# Initialize with default configuration (works with standard CSV format)\nprocessor = RegistrationProcessor()\n\n# Process a CSV file - default expects columns: Email, Full Name, LinkedIn URL, State Board Name, Registration Number, State Board Code\nresults = processor.process_csv(\"path/to/your/registrations.csv\")\n\n# Save results as JSON\nprocessor.save_json(results, \"output.json\")\n```\n\n## CSV Format\n\nThe default configuration expects a headerless CSV with these columns in order:\n\n1. Email\n2. Full Name\n3. LinkedIn URL\n4. State Board Name (e.g., \"NSW Architects Registration Board\")\n5. Registration Number\n6. State Board Code (e.g., \"NSW\", \"QLD\")\n\n## Supported Registration Bodies\n\n- NSW Architects Registration Board\n- Board of Architects of Queensland\n- ~Northern Territory Architects Board~ not yet\n- ~Architects Registration Board of Victoria~ not yet\n- ~Registered Design Practitioner NSW~ not yet\n\n## Configuration\n\nThe package works out-of-the-box with the standard CSV format, but supports custom configuration:\n\n```python\nfrom reggie import RegistrationProcessor, ProcessingConfig\n\n# For different CSV formats, customize the configuration\nconfig = ProcessingConfig(\n # If your CSV has different column names:\n column_names=[\"email\", \"name\", \"linkedin\", \"body\", \"number\", \"state\"],\n email_column=\"email\",\n full_name_column=\"name\",\n\n # Processing options:\n check_registrations=True, # Set to False to skip web scraping\n selenium_headless=True, # Set to False to see browser window\n output_format=\"json\"\n)\n\nprocessor = RegistrationProcessor(config=config)\n```\n\n## Development\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for checking professional registration status across various certification bodies",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://arch-reggie.readthedocs.io",
"Homepage": "https://github.com/bvn-architecture/Reggie",
"Issues": "https://github.com/bvn-architecture/arch-reggie/issues",
"Repository": "https://github.com/bvn-architecture/Reggie"
},
"split_keywords": [
"bvn",
" nsw",
" qld",
" architecture",
" registration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59f612eeb6e2e23d1b5c9fe82979c9669ed51d0d576e0ad60e6da32a33b627df",
"md5": "eac238e6490d19f9898b997e56766523",
"sha256": "a22fc5eef6b5dc3c07ba246a9849eb7b42e56b7fd65a81cb39185e6bd74ad7bb"
},
"downloads": -1,
"filename": "arch_reggie-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eac238e6490d19f9898b997e56766523",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15479,
"upload_time": "2025-07-09T07:35:20",
"upload_time_iso_8601": "2025-07-09T07:35:20.591877Z",
"url": "https://files.pythonhosted.org/packages/59/f6/12eeb6e2e23d1b5c9fe82979c9669ed51d0d576e0ad60e6da32a33b627df/arch_reggie-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e039fabc293d18044d5412c58e357a66170c4296329f1ac7cff3c270d61f93b4",
"md5": "b95f3af6e80682cf9c7fb55a395d1ae8",
"sha256": "15fe8365994ad30b81d999cf0f58843cc5d512a921e66a523ae5233b467c5646"
},
"downloads": -1,
"filename": "arch_reggie-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b95f3af6e80682cf9c7fb55a395d1ae8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1176206,
"upload_time": "2025-07-09T07:35:25",
"upload_time_iso_8601": "2025-07-09T07:35:25.207656Z",
"url": "https://files.pythonhosted.org/packages/e0/39/fabc293d18044d5412c58e357a66170c4296329f1ac7cff3c270d61f93b4/arch_reggie-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 07:35:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bvn-architecture",
"github_project": "Reggie",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "arch-reggie"
}
