{"id":13627061,"url":"https://github.com/Jojain/Nales","last_synced_at":"2025-04-16T19:31:01.584Z","repository":{"id":190832207,"uuid":"409729323","full_name":"Jojain/Nales-cadquery","owner":"Jojain","description":null,"archived":true,"fork":false,"pushed_at":"2022-03-21T21:51:25.000Z","size":1480,"stargazers_count":12,"open_issues_count":5,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-08T17:48:01.029Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jojain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-09-23T20:05:33.000Z","updated_at":"2023-11-05T20:43:58.000Z","dependencies_parsed_at":"2023-08-26T16:43:14.965Z","dependency_job_id":null,"html_url":"https://github.com/Jojain/Nales-cadquery","commit_stats":null,"previous_names":["jojain/nales"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jojain%2FNales-cadquery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jojain%2FNales-cadquery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jojain%2FNales-cadquery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jojain%2FNales-cadquery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jojain","download_url":"https://codeload.github.com/Jojain/Nales-cadquery/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249268548,"owners_count":21240940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T22:00:29.739Z","updated_at":"2025-04-16T19:31:01.016Z","avatar_url":"https://github.com/Jojain.png","language":"Python","funding_links":[],"categories":["Miscellaneous"],"sub_categories":[],"readme":"# Nales\n\nNales is a GUI CAD application that aims to bring full interactivity to [CadQuery](https://github.com/CadQuery/cadquery/blob/master/README.md)\n\nIt is however still a work in progress and a lot of things are still bugged / not implemented\n\n\n![Nales](./docs/readme_img_presentation.PNG)\n\n## What does it bring more than plain CadQuery ?\n\nIf you have used CadQuery and felt annoyed by :\n- The time spent rerendering your whole model when you change a small parameter value\n- The lack of visualisation tools, like clipping planes, measurements tools, etc.\n- Not having a GUI to display nicely what you are building\n\nThen you might be interested by Nales which aims to solve all of these points and more.\n\n:warning: **Nales is currently barely usable, expect a lot of issues/crash so beware of what you are doing**\n\n## Roadmap\n\nThere is a lot of things planned but not so much time to develop, however here is a list of what is expected to be in Nales in the near future:\n\n- Support for Sketch and Assemblies\n- Allow function creation/edition through the GUI\n- Allow editing of color / alpha for all shapes displayed in the viewer\n- Clipping planes\n- Measurements tools\n- Code synthesis through the GUI (Selector synthesis, Assembly constraint synthesis, etc)\n- And much more (you can propose improvements you would like to see)\n\nRoadmap is allowed to evolve as the project takes shape, any idea or contribution is welcome.\n\n## Installation \n\nYou will need Anaconda (or miniconda) to install Nales \n([Miniconda installation guide](https://docs.conda.io/en/latest/miniconda.html)).\n\nFirst create a conda env and activate it\n\n```\nconda create -n nales\nconda activate nales\n```\n\nClone this repo somewhere.\n\n\nThen in the top level repo run (it will install all the needed dependencies required to run Nales): \n\n```\nconda env update --file environment.yml -n nales\n```\n\nThen install nales\n```\npython setup.py install\n```\n\nYou should now be able to launch nales by running the `run_nales.py` script available in the scripts folder\n\n```\npython run_nales.py\n```\n\n## How to use Nales ?\n\nYou can type cadquery code in the console and that will directly populate the tree view on the left.\n\nNote that you don't have to import any Cadquery related libraries, everything is already available in the Nales console. For now the console comes loaded with these classes :\n\n- Shape\n- Vertex\n- Edge\n- Wire \n- Face \n- Solid\n- Compound\n- Part \n- nales\n\nAll the topological classes are wrappers around the Cadquery ones, so you can use them as you would use Cadquery ones.\n\nThe `Part` class is a wrapper around the Workplane class of Cadquery that handles GUI stuff. (There is also `Workplane` available which is an alias for `Part`)\n\nFinally the `nales` namespace provide an API of nales internals, even if it not really the case yet, the goal is to make all the GUI actions available from code within the `nales` namespace. \nType `help(nales)` to view all the actions already available.\n\nYou can also try out  and load the [Examples](./examples/). (which are borrowed from the CQ repo):\n\n\n## Shortcuts\n\nThere is already some shortcuts available for you to use :\n- ctrl+z / ctrl+y -\u003e undo / redo\n- f -\u003e fit the view of the viewer to the shape (click in the tree view to loose console focus)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJojain%2FNales","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJojain%2FNales","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJojain%2FNales/lists"}