aiondtech 2.1.0__tar.gz → 2.3.0__tar.gz

{aiondtech-2.1.0 → aiondtech-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiondtech
-Version: 2.1.0
+Version: 2.3.0
 Summary: Official Python SDK for AiondTech Resume Analyser API
 Author-email: AiondTech <support@aiondtech.com>
 Maintainer-email: AiondTech <support@aiondtech.com>
@@ -77,15 +77,17 @@ client = ResumeAnalyser(api_key="your-api-key", production=True)
 
 ## API Endpoints
 
+Credit usage varies depending on resume size and complexity. Every response includes the actual `credits_used` — always check it for accurate tracking.
+
 | Method | Credits | Description |
 |--------|---------|-------------|
-| `resumes.upload()` | 1 | Upload PDF resume |
-| `resumes.upload_and_analyze()` | 3 | Upload + AI parsing |
-| `resumes.upload_analyze_compare()` | 6 | Upload + parse + compare to job |
-| `resumes.analyze()` | 2 | Parse existing resume by ID |
-| `resumes.compare_resumes()` | 3 | Compare resume to job |
+| `resumes.upload()` | Varies | Upload PDF resume |
+| `resumes.upload_and_analyze()` | Varies | Upload + AI parsing |
+| `resumes.upload_analyze_compare()` | Varies | Upload + parse + compare to job |
+| `resumes.analyze()` | Varies | Parse existing resume by ID |
+| `resumes.compare_resumes()` | Varies | Compare resume to job |
 | `resumes.list()` | 0 | List all resumes |
-| `jobs.create()` | 1 | Create job posting |
+| `jobs.create()` | Varies | Create job posting |
 | `jobs.list()` | 0 | List all jobs |
 | `credits.balance()` | 0 | Check credit balance |
 | `credits.usage()` | 0 | View usage history |
@@ -100,15 +102,18 @@ Upload a PDF resume without parsing. Returns a `resume_id` for later use.
 
 ```python
 result = client.resumes.upload("path/to/resume.pdf")
+
+print(f"Resume ID: {result.resume_id}")
+print(f"Message: {result.message}")
+print(f"Credits Used: {result.credits_used}")
 ```
 
-**Return type:** `ResumeUploadResult`
+**Output:**
 
-```python
-result.resume_id     # int — Unique resume ID
-result.message       # str — "Resume uploaded successfully"
-result.credits_used  # int — 1
-result._raw          # dict — Full raw API response
+```
+Resume ID: 450
+Message: Resume uploaded successfully
+Credits Used: 1
 ```
 
 ---
@@ -119,25 +124,31 @@ Upload a PDF and immediately extract structured data (AI-powered parsing).
 
 ```python
 result = client.resumes.upload_and_analyze("path/to/resume.pdf")
-```
 
-**Return type:** `ResumeAnalysisResult`
+print(f"Resume ID: {result.resume_id}")
+print(f"Full Name: {result.full_name}")
+print(f"Email: {result.email}")
+print(f"Skills: {result.skills}")
+print(f"Job Titles: {result.job_titles}")
+print(f"Total Experience: {result.total_experience}")
+print(f"Credits Used: {result.credits_used}")
+print(f"Parsed Data: {result.parsed_data}")
+```
 
-```python
-result.resume_id     # int — Unique resume ID
-result.parsed_data   # dict — Full parsed data (see structure below)
-result.credits_used  # int — 3
-result._raw          # dict — Full raw API response
+**Output:**
 
-# Convenience properties
-result.full_name         # str | None
-result.email             # str | None
-result.skills            # list[str]
-result.job_titles        # list[str]
-result.total_experience  # str | None
+```
+Resume ID: 450
+Full Name: John Doe
+Email: john@example.com
+Skills: ['Python', 'Django', 'AWS']
+Job Titles: ['Senior Developer', 'Tech Lead']
+Total Experience: 8 years
+Credits Used: 5
+Parsed Data: {'full_name': 'John Doe', 'email': 'john@example.com', ...}
 ```
 
-**`parsed_data` structure:**
+**Full `parsed_data` structure:**
 
 ```python
 {
@@ -163,20 +174,25 @@ result.total_experience  # str | None
 Upload a resume, parse it, and compare against a job posting in one call.
 
 ```python
-result = client.resumes.upload_analyze_compare("resume.pdf", job_id=42)
+result = client.resumes.upload_analyze_compare("resume.pdf", job_id=56)
+
+print(f"Resume ID: {result.resume_id}")
+print(f"Job ID: {result.job_id}")
+print(f"Score: {result.comparison_score}")
+print(f"Reason: {result.comparison_reason}")
+print(f"Parsed Data: {result.parsed_data}")
+print(f"Credits Used: {result.credits_used}")
 ```
 
-**Return type:** `ResumeComparisonResult`
+**Output:**
 
-```python
-result.resume_id         # int — Resume ID
-result.job_id            # int — Job ID compared against
-result.comparison_score  # float — Match score (0-100)
-result.comparison_reason # str — Detailed reasoning
-result.language          # str | None — Detected language (e.g. "en", "ar")
-result.parsed_data       # dict | None — Parsed resume data
-result.credits_used      # int — 6
-result._raw              # dict — Full raw API response
+```
+Resume ID: 449
+Job ID: 56
+Score: 30
+Reason: The candidate has a strong technical background...
+Parsed Data: {'full_name': 'Salem O. Ba Atya', 'email': 'Baatyaso@gmail.com', ...}
+Credits Used: 9
 ```
 
 ---
@@ -186,30 +202,43 @@ result._raw              # dict — Full raw API response
 Parse an already-uploaded resume by its ID.
 
 ```python
-result = client.resumes.analyze(resume_id=123)
+result = client.resumes.analyze(resume_id=444)
+
+print(f"Resume ID: {result.resume_id}")
+print(f"Partner: {result.partner}")
+print(f"Full Name: {result.full_name}")
+print(f"Email: {result.email}")
+print(f"Phone: {result.phone}")
+print(f"LinkedIn: {result.linkedin}")
+print(f"Location: {result.location}")
+print(f"Skills: {result.skills}")
+print(f"Job Titles: {result.job_titles}")
+print(f"Companies: {result.companies}")
+print(f"Education: {result.education}")
+print(f"Total Experience: {result.total_experience}")
+print(f"Certifications: {result.certifications}")
+print(f"Credits Used: {result.credits_used}")
+print(f"Parsed Data: {result.parsed_data}")
 ```
 
-**Return type:** `ParsedResumeResult`
+**Output:**
 
-```python
-result.resume_id     # int — Resume ID
-result.partner       # str — Partner identifier
-result.parsed_data   # dict — Full parsed data
-result.credits_used  # int — 2
-result._raw          # dict — Full raw API response
-
-# Convenience properties
-result.full_name         # str | None
-result.email             # str | None
-result.phone             # str | None
-result.linkedin          # str | None
-result.location          # str | None
-result.skills            # list[str]
-result.job_titles        # list[str]
-result.companies         # list[str]
-result.education         # list[str]
-result.total_experience  # str | None
-result.certifications    # list[str]
+```
+Resume ID: 444
+Partner: your-partner-id
+Full Name: John Doe
+Email: john@example.com
+Phone: +1234567890
+LinkedIn: linkedin.com/in/johndoe
+Location: New York, NY
+Skills: ['Python', 'Django', 'AWS']
+Job Titles: ['Senior Developer', 'Tech Lead']
+Companies: ['Google', 'Meta']
+Education: ['BSc Computer Science - MIT']
+Total Experience: 8 years
+Certifications: ['AWS Certified Solutions Architect']
+Credits Used: 3
+Parsed Data: {'full_name': 'John Doe', ...}
 ```
 
 ---
@@ -223,18 +252,24 @@ job = client.jobs.create(
     title="Senior Python Developer",
     description="We are looking for an experienced Python developer..."
 )
+
+print(f"Job ID: {job.job_id}")
+print(f"Title: {job.title}")
+print(f"Description: {job.description}")
+print(f"Created By: {job.created_by}")
+print(f"Created At: {job.created_at}")
+print(f"Credits Used: {job.credits_used}")
 ```
 
-**Return type:** `JobResult`
+**Output:**
 
-```python
-job.job_id       # int — Unique job ID
-job.title        # str — Job title
-job.description  # str — Job description
-job.created_by   # str — Creator identifier
-job.created_at   # str | None — Creation timestamp
-job.credits_used # int — 1
-job._raw         # dict — Full raw API response
+```
+Job ID: 57
+Title: Senior Python Developer
+Description: We are looking for an experienced Python developer...
+Created By: your-partner-id
+Created At: 2026-02-06T10:30:00Z
+Credits Used: 1
 ```
 
 ---
@@ -244,19 +279,25 @@ job._raw         # dict — Full raw API response
 Compare an existing resume against an existing job posting.
 
 ```python
-result = client.resumes.compare_resumes(resume_id=123, job_id=456)
+result = client.resumes.compare_resumes(resume_id=445, job_id=56)
+
+print(f"Resume ID: {result.resume_id}")
+print(f"Job ID: {result.job_id}")
+print(f"Score: {result.comparison_score}")
+print(f"Reason: {result.comparison_reason}")
+print(f"Language: {result.language}")
+print(f"Credits Used: {result.credits_used}")
 ```
 
-**Return type:** `ResumeComparisonResult`
+**Output:**
 
-```python
-result.resume_id         # int — Resume ID
-result.job_id            # int — Job ID
-result.comparison_score  # float — Match score (0-100)
-result.comparison_reason # str — Detailed reasoning
-result.language          # str | None — Detected language (e.g. "en", "ar")
-result.credits_used      # int — 3
-result._raw              # dict — Full raw API response
+```
+Resume ID: 445
+Job ID: 56
+Score: 75
+Reason: The candidate demonstrates strong alignment with the role requirements...
+Language: en
+Credits Used: 5
 ```
 
 ---
@@ -267,23 +308,28 @@ List all uploaded resumes with pagination.
 
 ```python
 result = client.resumes.list(page=1, limit=50)
-```
 
-**Return type:** `ResumeListResult`
+print(f"Total: {result.total}")
+print(f"Page: {result.page}")
+print(f"Limit: {result.limit}")
+print(f"Has More: {result.has_more}")
+print(f"Count: {len(result)}")
 
-```python
-result.resumes   # list[dict] — List of resume objects
-result.total     # int — Total number of resumes
-result.page      # int — Current page
-result.limit     # int — Items per page
-result.has_more  # bool — Whether more pages exist
-result._raw      # dict — Full raw API response
-
-# Iterable
 for resume in result:
-    print(resume["id"], resume.get("full_name"))
+    print(f"  ID: {resume['id']}, Name: {resume.get('full_name')}, File: {resume.get('filename')}")
+```
+
+**Output:**
 
-len(result)  # Number of resumes on this page
+```
+Total: 120
+Page: 1
+Limit: 50
+Has More: True
+Count: 50
+  ID: 450, Name: John Doe, File: resume.pdf
+  ID: 449, Name: Salem O. Ba Atya, File: Salem_20220524.pdf
+  ...
 ```
 
 ---
@@ -294,21 +340,28 @@ List all job postings with pagination.
 
 ```python
 result = client.jobs.list(page=1, limit=50)
-```
 
-**Return type:** `JobListResult`
+print(f"Total: {result.total}")
+print(f"Page: {result.page}")
+print(f"Limit: {result.limit}")
+print(f"Has More: {result.has_more}")
+print(f"Count: {len(result)}")
 
-```python
-result.jobs      # list[dict] — List of job objects
-result.total     # int — Total number of jobs
-result.page      # int — Current page
-result.limit     # int — Items per page
-result.has_more  # bool — Whether more pages exist
-result._raw      # dict — Full raw API response
-
-# Iterable
 for job in result:
-    print(job["id"], job["title"])
+    print(f"  ID: {job['id']}, Title: {job['title']}")
+```
+
+**Output:**
+
+```
+Total: 10
+Page: 1
+Limit: 50
+Has More: False
+Count: 10
+  ID: 56, Title: Senior Python Developer
+  ID: 55, Title: Data Scientist
+  ...
 ```
 
 ---
@@ -317,18 +370,22 @@ for job in result:
 
 ```python
 balance = client.credits.balance()
+
+print(f"Total: {balance.get('total')}")
+print(f"Used This Month: {balance.get('used_mtd')}")
+print(f"Remaining: {balance.get('remaining')}")
+print(f"Plan: {balance.get('plan_name')}")
+print(f"Resets At: {balance.get('resets_at')}")
 ```
 
-**Returns:** `dict`
+**Output:**
 
-```python
-{
-    "total": 1000,
-    "used_mtd": 150,
-    "remaining": 850,
-    "plan_name": "Professional",
-    "resets_at": "2026-03-01T00:00:00Z"
-}
+```
+Total: 1000
+Used This Month: 150
+Remaining: 850
+Plan: Professional
+Resets At: 2026-03-01T00:00:00Z
 ```
 
 ---
@@ -337,8 +394,11 @@ balance = client.credits.balance()
 
 ```python
 usage = client.credits.usage()
+print(usage)
+
 # Or with date filters
 usage = client.credits.usage(start_date="2026-01-01", end_date="2026-01-31")
+print(usage)
 ```
 
 ---
@@ -390,13 +450,14 @@ job = client.jobs.create(
     title="Senior Python Developer",
     description="5+ years Python, Django, AWS, PostgreSQL required..."
 )
-print(f"Created job #{job.job_id}: {job.title}")
+print(f"Created job #{job.job_id}: {job.title} ({job.credits_used} credits)")
 
 # Step 2: Upload and analyze a resume
 analysis = client.resumes.upload_and_analyze("candidate_resume.pdf")
 print(f"Candidate: {analysis.full_name}")
 print(f"Skills: {', '.join(analysis.skills)}")
 print(f"Experience: {analysis.total_experience}")
+print(f"Credits used: {analysis.credits_used}")
 
 # Step 3: Compare resume to job
 comparison = client.resumes.compare_resumes(
@@ -404,8 +465,8 @@ comparison = client.resumes.compare_resumes(
     job_id=job.job_id
 )
 print(f"Score: {comparison.comparison_score}%")
-print(f"Language: {comparison.language}")
 print(f"Reasoning: {comparison.comparison_reason}")
+print(f"Credits used: {comparison.credits_used}")
 
 # Step 4: Check remaining credits
 balance = client.credits.balance()
@@ -417,6 +478,7 @@ print(f"Credits remaining: {balance['remaining']}")
 ```python
 result = client.resumes.upload_analyze_compare("resume.pdf", job_id=job.job_id)
 print(f"Score: {result.comparison_score}% — {result.comparison_reason}")
+print(f"Credits used: {result.credits_used}")
 ```
 
 ### Batch Processing
@@ -426,18 +488,22 @@ import os
 
 job = client.jobs.create("Data Scientist", "ML, Python, statistics...")
 
+total_credits = job.credits_used
 results = []
+
 for pdf in os.listdir("resumes/"):
     if pdf.endswith(".pdf"):
         r = client.resumes.upload_analyze_compare(
             f"resumes/{pdf}", job_id=job.job_id
         )
         results.append(r)
-        print(f"{r.comparison_score:5.1f}% — {pdf}")
+        total_credits += r.credits_used
+        print(f"{r.comparison_score:5.1f}% — {pdf} ({r.credits_used} credits)")
 
 # Sort by score
 results.sort(key=lambda x: x.comparison_score, reverse=True)
 print(f"\nTop candidate: resume_id={results[0].resume_id} ({results[0].comparison_score}%)")
+print(f"Total credits used: {total_credits}")
 ```
 
 ---