ancv 0.4.0

Render 'JSON Resume' sources to ANSI-enriched output for terminal clients (cURL, wget, ...) to consume.

ancv

Getting you an CV (ANSI-v?) straight to your terminal.

Be warned though, this is entirely useless:

Getting started

1. Create a resume according to the JSON Resume Schema (schema specification) either:

   • manually,
   • exporting from LinkedIn using Joshua Tzucker's LinkedIn exporter (repo), or
   • exporting from one of the platforms advertised as offering JSON resume integration:
     • https://gitconnected.com/portfolio-api
     • https://represent.io/
     • https://www.doyoubuzz.com/us/

2. Create a gist named resume.json with those resume contents. See here for a working example from a JSON Resume co-founder.

3. Try it out!

   curl -L ancv.io/username
   

Design

Features

This being a hobby project, new (and old) features were tried out and used:

• fully async using aiohttp and gidgethub
• structural pattern matching, introduced in Python 3.10 Not used since unsupported by AWS lambda (2022-07-16)
• fully typed using Python type hints, verified through mypy --strict (with additional, even stricter settings)
• structural logging with a JSON event stream output
• pydantic for fully typed data validation (e.g., for APIs), facilitated by automatic pydantic model generation from e.g. OpenAPI specs like GitHub's or JSON Resume's, allowing full support from mypy and the IDE when using said validated data
• 12 Factor App conformance:
  1. Codebase: GitHub-hosted repo
  2. Dependencies: taken care of by poetry and its standardized (PEP 621) config and lock files, pinning all transient dependencies and providing virtual environments
  3. Config: the app is configured using environment variables. Although problematic, this approach was chosen for its simplicity
  4. Backing Services: not applicable for this very simple app
  5. Build, release, run: handled through GitHub releases via git tags
  6. Processes: this simple app is stateless in and of itself
  7. Port binding: the aiohttp server part of the app acts as a standalone web server, exposing a port. That port can then be serviced by any arbitrary reverse proxy
  8. Concurrency: covered by async functionality (in a single process and thread). This being a stateless app, horizontal scaling through additional processes is trivial (e.g. via serverless hosting), although vertical scaling will likely suffice indefinitely
  9. Disposability: aiohttp handles SIGTERM gracefully
  10. Dev/prod parity: trivial to do for this simple app. If running on Windows, mind this issue. If running on Linux, no special precautions are necessary
  11. Logs: structural JSON logs are written directly to stdout
  12. Admin processes: not applicable either

Concept

(put this as an SVG flowchart, left to right with conceptual sketches)

Skeleton + Theme + Language + ASCII-mode toggle + Resume Data ==> terminal CV

Contributing

Set up your environment:

1. Install poetry
2. Run poetry install
3. Enter into the created environment with poetry shell
4. Set up git hooks provided by pre-commit: make hooks

TODO

• Core application
  • 3 full templates implemented
  • ASCII-safe mode implemented
• Implement test suite
  • Unit tests (not many to do...)
  • Integration tests:
    • Create one fully featured JSON resume
    • Create derived resumes with all possible fields (all combinations thereof?) set to None where legal (given the schema)
    • Compare all these to expected files (the files contain the ANSI escape characters literally)
  • Load tests
• Other
  • https://ancv.io landing page for browsers (just a redirect to GitHub for now)
  • Venn diagram
    • Hand- [ ]draw on ReMarkable?
    • One circle: 'people working with resumes'
    • other circle: 'people working with terminals'
    • tiny overlap: 'you', with arrow
  • Demos
    • curl, wget (PowerShell?) examples
    • all templates
      • all languages

Roadmap

• Multiple locale support for hardcoded strings (like Present for a missing end date)
  • German, French, Spanish
• Image support (fetch bitmap, convert to ASCII art (random example))

Other solutions

Very hard to find any, and even hard to google. For example, bash curl curriculum vitae will prompt Google to interpret curriculum vitae == resume, which isn't wrong but curl resume is an entirely unrelated query (concerned with resuming halted downloads and such).

• https://github.com/soulshake/cv.soulshake.net

Related, but 'fake' hits:

• https://ostechnix.com/create-beautiful-resumes-commandline-linux/