mirror of
https://github.com/rendercv/rendercv.git
synced 2026-04-20 06:51:51 -04:00
5cc5fbdf9e
* Rename `data` folder with schema * Start refactoring data models * Work on entry models * Keep working on entries * Keep working on data models * Push old data files * Keep working on data models * First draft of schema.cv * Keep working on schema * Keep working on schema * Improve schema.models * Keep working on rendercv.schema * Work on schema.design * Keep working on rendercv.schema * Complete variant_class_generator * Keep working rendercv.schema * Keep working on rendercv.schema * Final touches to rendercv.schema * Improve json schema descriptions in rendercv.schema * Start working on rendercv.schema tests * Keep implementing rendercv.schema tests * Add more tests for rendercv.schema * Improve rendercv.schema * Improve docstrings and comments in rendercv.schema * Implement better pydantic error handling in `rendercv.schema` * Improve variant class system * Fix rendercv.schema tests * Start working on rendercv.templater * Update template names * Switching to new rendercv typst template soon * Work on new templater * Rename renderer with renderer_old * Don't use utils in rendercv.schema * Complete connections * Update renderer folder structure * Work on new renderer * Work on new renderer * Date processing on new renderer * Improve date processing, support multiple emails, phones, and websites * Improve markdown to Typst * Complete entry template processing * Time span computation in new renderer * Better entry templates * Setup new templates * Improve rendercv.schema * Start adding tests for rendercv.renderer * New markdown parser! * Improve markdown to typst conversion * Finalize markdown parser * Add new test files for rendercv.renderer * Fix cv and connections * Add connections test * Improve connection tests * Improve entry templates * Add model processor tests * Improve templater * Rename old folders * Improve schema * Add file generation logic to renderer * Fix naming issues * Fix schema tests * Add path type tests * Add font family and typst dimension type tests * Rename old tests * Fix design tests * Start integration testing of renderer * Improve entry tempates * Handle nested highlights properly * Finalize Typst preamble template * Start working on new CLI * Remove old test files * Implement override dictionary in new schema * Start working on new CLI * Better prints on render command * New structure * New render printer * Add all the commands to new CLI * Work on new command in new cli * Improve new command * Add error handler to new cli * Work on create theme command * Complete create theme command * Remove old source files * Improve exceptions * Create new docs * Add writing tests guide * Fix cli printer and write tests * Test copy templates * Add app tests * Bring back accidentally removed files * Imporve cli and tests * Fix path issues * Improve * Improve * Add reference file comparison tests * Fix path resolver * Start working on test_pdf_png * Implement comparison of multiple files (png) * Start testing typst * Fix templating issues * Fix header and entry templates issues * Implement short second rows * Fix date issues * Fix nested bullets and add summary * Update testdata * Implement footer * Update testdata * Reimagined design and locale schema, first iteration * Reimagined design and locale second iteration * Update design and locale schemas * Adapt templater to the new design and locale * Fix tests * Update lib.typ and testdata for the new locale and design * Implement proper tests with all combinations of entries * Remove some docstrings * fix connections logic * Improve * Start working on examples * Update testdata * Fix long second row issue * fix templating issues * Fix lib.typ issues * Update testdata * Fix clean_trailing_parts * Update test cv * update test cv * Update theme defaults * update schema and fix moderncv * Fix moderncv issues * Update testdata * Update testdata and examples * Fix issues about photo * Fix typst photo path issues * improve entry templates from yaml * add new locale * Rename writing tests doc * Update writing tests * Improve tests * Add more cli tests * Increase test coverage * Rename variant pydantic model generator * Improve tests * Update testdata and improve tests * Format, fix pre-commit errors * Fix scripts and update entry figures * Improve tests * Write docstrings of schema * Write schema docstrings * Setup api reference * Start working on new docs * Work on docs * Improve progress panel of render command * Finalize new docs index * Complete CLI docs * Work on YAML input structure page * Finalize user guide * Start working on developer guide * Improve api reference * Improve developer guide * Improve developer guide * Improve developer gide * Improve developer guide * Improve developer guide * Update developer guide * Improve developer guide * Improve developer guide * Improve developer guide * Developer guide first draft * update developer guide * Update examples * Update testdata * Handle wrong installation (rendercv instead of rendercv[full]) * Remove unnecessary files * Write set up vs code page * Update README.md * Change docs description * Compress design options gif * minor updates * Polish all the json schema descriptions * Update testdata and examples * Remove some emdashed from docs * Add whatsapp support * Add TestEscapeTypstCharacters to tests * Implement custom connections * Add page break before sections feature * Revert page break before sections feature * Rebase to main * Fix social network tests, update schema
79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
---
|
|
toc_depth: 1
|
|
---
|
|
|
|
# Setup
|
|
|
|
## Prerequisites
|
|
|
|
You need two tools to develop RenderCV:
|
|
|
|
- **[`uv`](https://docs.astral.sh/uv/)**: Package and project manager. RenderCV uses `uv` to manage dependencies. It also handles Python installations, so you don't need to install Python separately.
|
|
- **[`just`](https://github.com/casey/just)**: Command runner. Development commands are defined in the [`justfile`](https://github.com/rendercv/rendercv/blob/main/justfile), and you need `just` to run them.
|
|
|
|
Install them by following their official installation guides:
|
|
|
|
- [Install `uv`](https://docs.astral.sh/uv/getting-started/installation/)
|
|
- [Install `just`](https://github.com/casey/just#installation)
|
|
|
|
## Setting Up the Development Environment
|
|
|
|
1. Clone the repository:
|
|
|
|
```bash
|
|
git clone https://github.com/rendercv/rendercv.git
|
|
```
|
|
|
|
and change to the repository directory:
|
|
|
|
```bash
|
|
cd rendercv
|
|
```
|
|
|
|
2. Set up the development environment (creates a virtual environment in `./.venv` with all dependencies):
|
|
|
|
```bash
|
|
just sync
|
|
```
|
|
|
|
3. Run `just test` to verify all tests pass and everything is set up correctly.
|
|
|
|
4. Finally, activate the virtual environment in your integrated development environment (IDE). In Visual Studio Code:
|
|
|
|
- Press `Ctrl+Shift+P`.
|
|
- Type `Python: Select Interpreter`.
|
|
- Select the one in `./.venv`.
|
|
|
|
|
|
That's it! You're now ready to start developing RenderCV.
|
|
|
|
## Available Commands
|
|
|
|
### Development
|
|
|
|
- `just sync`: Sync all dependencies (including extras and dev groups)
|
|
- `just format`: Format code with black and ruff
|
|
- `just check`: Run all checks (ruff, pyright, pre-commit)
|
|
|
|
### Testing
|
|
|
|
- `just test`: Run tests with pytest
|
|
- `just test-coverage`: Run tests with coverage report
|
|
- `just update-testdata`: Update test data files (see [Testing](testing.md) for more details)
|
|
|
|
### Documentation
|
|
|
|
- `just build-docs`: Build documentation
|
|
- `just serve-docs`: Serve documentation locally with live reload
|
|
|
|
### Scripts
|
|
|
|
- `just update-schema`: Update JSON schema
|
|
- `just update-entry-figures`: Update entry figures for documentation
|
|
- `just update-examples`: Update example files
|
|
- `just create-executable`: Create standalone executable
|
|
|
|
### Utilities
|
|
|
|
- `just count-lines`: Count lines of Python code in the `src/` directory
|