https://github.com/alexpovel/ancv

Renders your (JSON) resume/CV for online & pretty terminal display
https://github.com/alexpovel/ancv

ansi-colors api asyncio curriculum-vitae cv hacktoberfest mypy pydantic python python-3-10 resume resume-generator resume-template rich serverless terminal typed

Last synced: 22 days ago
JSON representation

Renders your (JSON) resume/CV for online & pretty terminal display

• Host: GitHub
• URL: https://github.com/alexpovel/ancv
• Owner: alexpovel
• License: mit
• Created: 2022-05-30T18:51:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T09:42:45.000Z (about 1 month ago)
• Last Synced: 2024-10-04T10:33:37.519Z (about 1 month ago)
• Topics: ansi-colors, api, asyncio, curriculum-vitae, cv, hacktoberfest, mypy, pydantic, python, python-3-10, resume, resume-generator, resume-template, rich, serverless, terminal, typed
• Language: Python
• Homepage: https://ancv.io
• Size: 1.8 MB
• Stars: 241
• Watchers: 8
• Forks: 9
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [ancv](https://github.com/alexpovel/ancv)

Getting your resume aka [an CV](https://youtu.be/mJUtMEJdvqM?t=16) (*[ANSI](https://en.wikipedia.org/wiki/ANSI_escape_code)-v* 🤡) straight to your and anyone else's terminals:

![showcase cv terminal output](docs/images/showcase.svg)

---

Be warned though, for this is kinda useless and just for fun:



   



## Getting started

1. Create your resume according to the [JSON Resume Schema](https://jsonresume.org/schema/) (see also the [schema specification](https://github.com/jsonresume/resume-schema/blob/master/schema.json)) either:

   - use ChatGPT (or another LLM) with the following prompt (you need to fill in the spaces for `[resume]` and `[json_schema]`):

      ```

      Resume:[resume]

      JSON Resume Schema:[json_schema]

      Provide JSON data structure of the resume, formatted according to the JSON Resume Schema

      

      Output json, no yapping

      ```

      Note: for `json_schema` you can just use the example [from here](https://jsonresume.org/schema/)

   - manually (see [the `heyho` sample](./ancv/data/showcase.resume.json) for a possible starting point),

   - exporting from [LinkedIn](https://www.linkedin.com/) using [Joshua Tzucker's LinkedIn exporter](https://joshuatz.com/projects/web-stuff/linkedin-profile-to-json-resume-exporter/) ([repo](https://github.com/joshuatz/linkedin-to-jsonresume))[^1], or

   - exporting from one of the platforms advertised as offering [JSON resume integration](https://jsonresume.org/schema/).

2. [Create a **public** gist](https://gist.github.com/) named `resume.json` with your resume contents.

3. You're now the proud owner of an ancv.

   Time to try it out.

   The following examples work out-of-the-box.

   **Replace `heyho` with your GitHub username** once you're all set up.

   - curl:

      ```bash

      curl -L ancv.io/heyho

      ```

      with `-L` being shorthand for [`--location`](https://curl.se/docs/manpage.html), allowing you to follow the redirect from `http://ancv.io` through to `https://ancv.io`.

      It's shorter than its also perfectly viable alternative:

      ```bash

      curl https://ancv.io/heyho

      ```

      Lastly, you might want to page the output for easiest reading, top-to-bottom:

      ```bash

      curl -sL ancv.io/heyho | less

      ```

      If that garbles the rendered output, try `less -r` aka [`--raw-control-chars`](https://man7.org/linux/man-pages/man1/less.1.html).

   - wget:

     ```bash

     wget -O - --quiet ancv.io/heyho

     ```

     where `-O` is short for [`--output-document`](https://linux.die.net/man/1/wget), used here to redirect to stdout.

   - PowerShell 7:

     ```powershell

     (iwr ancv.io/heyho).Content

     ```

     where `iwr` is an alias for [`Invoke-Webrequest`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/invoke-webrequest?view=powershell-7.2), returning an object whose `Content` we access.

   - PowerShell 5:

     ```powershell

     (iwr -UseBasicParsing ancv.io/heyho).Content

     ```

     where `-UseBasicParsing` is *only* required if you haven't set up Internet Explorer yet ([yes, really](https://stackoverflow.com/q/38005341/11477374)).

     If you have, then it works as PowerShell 7 (where that flag is deprecated and the default anyway).

## Configuration

*All configuration is optional.*

The CV is constructed as follows:

![conceptual flow chart](docs/images/concept-flow-chart.svg)

In summary:

- you control:

  - the **template**.

    Essentially the order of items, indentations, text alignment, position of dates and more.

    Templates are like layouts/skeletons.

  - the **theme**.

    This controls colors, italics, boldface, underlining, blinking (yes, really) and more.

    A couple themes exist but you can easily add your own one.

  - the **language** to use.

    Pre-set strings like section titles (*Education*, ...), names of months etc. are governed by *translations*, of which there are a couple available already.

    All other text is free-form.

  - text content like emojis and newlines to control paragraph breaks.

    Emojis are user-controlled: if you want them, use them in your `resume.json`; in the future, there might be *templates* with emojis baked in, but you'd have to actively opt into using one.

  - date formatting, in a limited fashion through a special `dec31_as_year` toggle.

    If that toggle is `true`, dates in the format `YYYY-12-31` will be displayed as `YYYY` only.

  - lastly, there's a toggle for ASCII-only output.

    It only concerns the *template* and controls the drawing of boxes and such (e.g., [`-`](https://symbl.cc/en/002D/) versus [`─`](https://symbl.cc/en/2500/) : only the latter will produce gapless rules).

    If you yourself use non-ASCII characters in your texts, use a *language* containing non-ASCII characters (Spanish, French, ...) or a *theme* with non-ASCII characters (e.g., a theme might use the `•` character to print bullet points), non-ASCII Unicode will still occur.

    As such, this toggle currently isn't very powerful, but with some care it *does* ultimately allow you to be ASCII-only.

  If you come up with new templates, themes or translations, a PR would be highly appreciated.

- you *do not* control:

  - anything about a viewer's terminal!

    Any recent terminal will support a baseline of features (e.g., colors), but large parts of the functionalities depend on the *font* used: proper Unicode support is needed for pretty output (see `ascii_only`), and ideally emojis if you're into that (although it's easy to pick an emoji-free template).

    Many themes leverage Unicode characters as well.

  - access to your CV: like the gist itself, it will be publicly available on GitHub.

### How to configure

Configuring `ancv` requires going beyond the vanilla JSON Resume schema.

You will need to add an (entirely optional) `$.meta.ancv` field to your `resume.json`.

The [provided schema](schema.json) will be of help here:

an editor capable of providing auto-completion based on it, like [Visual Studio Code](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings), will make filling out the additional configuration a breeze.

The schema will further inform you of the default values (used for unspecified fields).

Since everything is optional, a [valid JSON resume](https://github.com/jsonresume/resume-schema/blob/master/schema.json) (without an `ancv` section) is valid for `ancv` use as well.

## Installation

### As a library

Install the package as usual:

```bash

pip install ancv

```

This also allows you to import whatever you could want or need from the package, if anything.

Note that it's pretty heavy on the dependencies.

### As a container

See also the available [packages aka images](https://github.com/alexpovel/ancv/pkgs/container/ancv):

```bash

docker pull ghcr.io/alexpovel/ancv

```

Versioned tags (so you can pin a major) are available.

### Local usage

Once installed, you could for example check whether your `resume.json` is valid at all (`validate`) or get a glimpse at the final product (`render`):

```bash

# pip route:

$ ancv render resume.json

# container route:

$ docker run -v $(pwd)/resume.json:/app/resume.json ghcr.io/alexpovel/ancv render

```

## Self-hosting

Self-hosting is a first-class citizen here.

### Context: Cloud Hosting

The  site is hosted on [Google Cloud Run](https://cloud.google.com/run) (serverless) and deployed there [automatically](https://github.com/alexpovel/ancv/runs/8172131447), such that the latest release you see here is also the code executing in that cloud environment.

That's convenient to get started: simply create a `resume.json` gist and you're good to go within minutes.

It can also be used for debugging and playing around; it's a playground of sorts.

You're invited to use this service for as much and as long as you'd like.

However, obviously, as an individual I cannot guarantee its availability in perpetuity.

You might also feel uncomfortable uploading your CV onto GitHub, since it *has* to be public for this whole exercise to work.

Lastly, you might also be suspicious of me inserting funny business into your CV before serving it out.

If this is you, self-hosting is for you.

### Setup

For simplicity, using Docker Compose (with Docker's recent [Compose CLI plugin](https://docs.docker.com/compose/install/compose-plugin/)):

1. Clone this repository onto your server (or fork it, make your edits and clone that)

2. `cd self-hosting`

3. Edit [Caddy's config file](./self-hosting/Caddyfile) ([more info](https://caddyserver.com/docs/caddyfile)) to contain your own domain name

4. Place your `resume.json` into the directory

5. Run `docker compose up`

Caddy (chosen here for simplicity) will handle HTTPS automatically for you, but will of course require domain names to be set up correctly to answer ACME challenges.

Handling DNS is up to you; for dynamic DNS, I can recommend [`qmcgaw/ddns-updater`](https://github.com/qdm12/ddns-updater).

If you self-host in the cloud, the server infrastructure might be taken care of for you by your provider already (as is the case for Google Cloud Run).

In these cases, a dedicated proxy is unnecessary and a single [Dockerfile](./Dockerfile) might suffice (adjusted to your needs).

True [serverless](https://www.serverless.com/) is also a possibility and an excellent fit here.

For example, one could use [Digital Ocean's *Functions*](https://docs.digitalocean.com/products/functions/).

If you go that route and succeed, please let me know! (I had given up with how depressingly hard dependency management was, as opposed to tried-and-tested container images.)

---



   

     

   



[^1]: The exporter has a couple caveats.

  You will probably not be able to paste its result into a gist and have it work out of the box.

  It is recommended to paste the export into an editor capable of helping you find errors against the contained `$schema`, like VS Code.

  Alternatively, a local `ancv render your-file.json` will print `pydantic` validation errors, which might be helpful in debugging.

  For example, the exporter might leave `$.basics.url` an empty string, which isn't a valid URI and therefore fails the schema and, by extension, `ancv`.

  Similarly, `endDate` keys might get empty string values.

  **Remove these entries** entirely to stay conformant to the JSON Resume Schema (to which `ancv` stays conformant).